Class SocketManager

Manages connections to a media socket, allowing users to connect or disconnect based on API credentials.

Name

SocketManager

Description

Provides methods to connect and disconnect from a media socket using a provided API key or token.

Method

validateApiKeyToken - Validates the API key or token for correct format. connectSocket - Establishes a connection to the media socket using either the API key or token. disconnectSocket - Disconnects an active socket connection.

Example

const socketManager = new SocketManager();

// Example of connecting to the socket
const socketConnection = await socketManager.connectSocket({
  apiUserName: 'user123',
  apiKey: 'validApiKeyOf64Characters',
  link: 'https://socketserver.example.com'
});

// Example of disconnecting the socket
const isDisconnected = await socketManager.disconnectSocket({
  socket: socketConnection
});

Returns

The active socket instance on connection, or a boolean indicating disconnection success.

Constructors

constructor

Methods

validateApiKeyToken connectSocket connectLocalSocket disconnectSocket

Constructors

constructor

Methods

validateApiKeyToken

connectSocket

  • connectSocket(options): Promise<Socket<DefaultEventsMap, DefaultEventsMap>>

  • Connects to a media socket using the provided connection options.

    Parameters

    Returns Promise<Socket<DefaultEventsMap, DefaultEventsMap>>

    A promise that resolves to the connected socket.

    Example

    const options = {
      apiUserName: 'user123',
      apiKey: 'validApiKeyOf64Characters',
      link: 'https://socketserver.example.com'
    };

    try {
      const socket = await connectSocket(options);
      console.log('Connected to socket:', socket);
    } catch (error) {
      console.error('Failed to connect to socket:', error);
    }

connectLocalSocket

  • connectLocalSocket(options): Promise<ResponseLocalConnection>

  • Connects to a local media socket using the provided connection options.

    Parameters

    Returns Promise<ResponseLocalConnection>

    A promise that resolves to the connected socket and data.

    Example

    const options = {
      link: "http://localhost:3000",
    };

    try {
      const { socket, data } = await connectLocalSocket(options);
      console.log("Connected to socket:", socket, data);
    } catch (error) {
      console.error("Failed to connect to socket:", error);
    }

disconnectSocket

  • disconnectSocket(options): Promise<boolean>

  • Disconnects an active socket connection.

    Parameters

    Returns Promise<boolean>

    A promise that resolves to true if the socket was disconnected successfully, or false otherwise.

    Example

    const options = {
      socket: mySocketInstance,
    };

    try {
      const isDisconnected = await disconnectSocket(options);
      console.log("Socket disconnected:", isDisconnected);
    } catch (error) {
      console.error("Failed to disconnect socket:", error);
    }

Settings

Member Visibility

On This Page

Constructors
Methods