SDK 使用的跨平台 Socket 实例接口。

interface SocketLike {
    readyState: number;
    send(data: SocketSendData): Promise<void>;
    close(code?: number, reason?: string): void;
    onOpen(handler: () => void): () => void;
    onMessage(handler: (data: SocketMessageData) => void): () => void;
    onError(handler: (error: unknown) => void): () => void;
    onClose(
        handler: (event: { code?: number; reason?: string }) => void,
    ): () => void;
}

Properties

readyState: number

当前 Socket 就绪状态。

Methods

  • 关闭连接。

    Parameters

    • Optionalcode: number
    • Optionalreason: string

    Returns void

  • 注册连接打开监听器并返回取消函数。

    Parameters

    • handler: () => void

    Returns () => void

  • 注册消息监听器并返回取消函数。

    Parameters

    Returns () => void

  • 注册错误监听器并返回取消函数。

    Parameters

    • handler: (error: unknown) => void

    Returns () => void

  • 注册关闭监听器并返回取消函数。

    Parameters

    • handler: (event: { code?: number; reason?: string }) => void

    Returns () => void