Constructor Detail

• CoordinatorSocketConnection

  CoordinatorSocketConnection(String apiKey, String url, User user, String token, OkHttpClient httpClient, NetworkStateProvider networkStateProvider, CoroutineScope scope, Lifecycle lifecycle, TokenProvider tokenProvider, TokenRepository tokenRepository)

  Backwards-compatible constructor for callers that still pass a fixed User.

Method Detail

• getDeliverOnMainThread

   Boolean getDeliverOnMainThread()

  The callbacks are by default delivered on the main thread. Changing this property to false will deliver the callbacks on their originating threads.

  Set to false for faster callback delivery on the original thread (no unnecessary context switching).

• onCreated

   Unit onCreated()

  Called when the socket is created.

• onConnecting

   Unit onConnecting()

  Invoked when the connection begins to establish and socket state changes to Connecting.

• onConnected

   Unit onConnected(ConnectedEvent event)

  Invoked when we receive the first ConnectedEventType in this connection.

  Note: This is not invoked when the ws connection is opened but when the ConnectedEventType is received.

  Parameters:

  event - ConnectedEventType sent by server as first event once the connection is established.

• onEvent

   Unit onEvent(VideoEvent event)

  Invoked when we receive any successful event.

  Parameters:

  event - parsed VideoEvent received in this web socket connection.

• onError

   Unit onError(StreamWebSocketEvent.Error error)

  Invoked when there is any error in this web socket connection.

  Parameters:

  error - Error object with the error details.

• onDisconnected

   Unit onDisconnected(DisconnectCause cause)

  Invoked when the web socket connection is disconnected.

  Parameters:

  cause - DisconnectCause reason of disconnection.

• connectionId

   StateFlow<String> connectionId()

  Get the connection id.

• whenConnected

   Unit whenConnected(Long connectionTimeout, SuspendFunction1<Throwable, Unit> connectionFailed, SuspendFunction1<String, Unit> connected)

  When connected to the socket.

• state

   StateFlow<VideoSocketState> state()

  State of the socket as StateFlow

• events

   Flow<VideoEvent> events()

  Socket events as Flow

• errors

   Flow<StreamWebSocketEvent.Error> errors()

  Socket errors as Flow

• sendData

   <ERROR CLASS> sendData(String data)

  Send raw data to the socket. If you already have a parsed event that can be sent. Refactor later to return bool

• sendEvent

   Boolean sendEvent(VideoEvent event)

  Send event to the socket.

• connect

   Unit connect(User connectData)

  Connect the user.

• reconnect

   Unit reconnect(User data, Boolean force)

  Reconnect the user to the socket.

• disconnect

   <ERROR CLASS> disconnect()

  Disconnect the socket.

• updateToken

   Unit updateToken(String token)

  Update the token from the outside.