Connection state management

​

Connection state diagram

​

State descriptions

​

State transition rules

1. App calls connect → enters Connecting.
2. Connection succeeds → transitions from Connecting to Connected.
3. Connection fails → transitions from Connecting to Failed, then the SDK automatically transitions to Disconnected.
4. Connection fails → transitions from Connected to Failed, then the SDK automatically transitions to Disconnected.
5. App calls disconnect → transitions from Connected to Disconnected.

​

connect API

​

Method signature

public abstract int connect(@NonNull AoqConnectConfig config);

- (int)connect:(AoqConnectConfig * _Nonnull)config;

connect(config: AoqConnectConfig): number;

​

Behavior

• Fires the onConnectionStatusChange(connecting) callback immediately after the call.
• Fires the onConnectionStatusChange(connected) callback if the connection succeeds.
• Fires the onConnectionStatusChange(failed) callback if the connection fails.

​

disconnect API

​

Method signature

public abstract int disconnect();

- (int)disconnect;

disconnect(): number;

​

Behavior

• Fires the onConnectionStatusChange(Disconnected) callback after the call.
• The engine is not released automatically. You can call connect again to reconnect.
• Calling disconnect when not connected is safe and returns 0.

​

onConnectionStatusChange callback

public void onConnectionStatusChange(
    @NonNull AoqClientEngine.AoqConnectionStatus status) {}

- (void)onConnectionStatusChange:(AoqConnectionStatus)status;

onConnectionStatusChange?: (status: AoqConnectionStatus) => void;

​

Example

func onConnectionStatusChange(_ status: AoqConnectionStatus) {
    switch status {
    case .connecting:
        print("Connecting...")
    case .connected:
        print("Connected")
        // You can send session.update after the connection is established
    case .failed:
        print("Connection failed")
        // The SDK will automatically transition to disconnected; no need to call disconnect manually
    case .disconnected:
        print("Disconnected")
        // Decide whether to reconnect based on your application logic
    }
}