sockets\socket_manager library
Classes
- ConnectLocalSocketOptions
- Options for connecting to a local socket.
- ConnectSocketOptions
- Options for connecting to a socket.
- DisconnectSocketOptions
- ResponseLocalConnection
- Response for local socket connection.
- ResponseLocalConnectionData
- Data received during local socket connection.
Functions
-
connectLocalSocket(
ConnectLocalSocketOptions options) → Future< ResponseLocalConnection> -
Connects to a media socket with the specified options.
Returns a
ResponseLocalConnection
containing the socket and connection data. Throws an exception if inputs are invalid or if connection fails. Example usage: -
connectSocket(
ConnectSocketOptions options) → Future< Socket> - Connects to a media socket with the specified options. Validates the API key or token and initiates a socket connection.
-
disconnectSocket(
DisconnectSocketOptions options) → Future< bool> -
Disconnects the given socket instance.
Returns
true
upon successful disconnection. -
validateApiKeyToken(
String value) → Future< bool> -
Validates the provided API key or token.
Returns
true
if the API key or token is valid, otherwise throws an exception.
Typedefs
-
ConnectLocalSocketType
= Future<
ResponseLocalConnection> Function(ConnectLocalSocketOptions options) -
ConnectSocketType
= Future<
Socket> Function(ConnectSocketOptions options) -
DisconnectSocketType
= Future<
bool> Function(DisconnectSocketOptions options)