WebsocketConnection class

Constructors

WebsocketConnection(string, IStringDictionary<string>, IStringDictionary, IWebsocketMessageFormatter, ProxyInfo, string)

Properties

dispose
events
id
isDisposed
open
read
send
state

Constructor Details

WebsocketConnection(string, IStringDictionary<string>, IStringDictionary, IWebsocketMessageFormatter, ProxyInfo, string)

new WebsocketConnection(uri: string, queryParameters: IStringDictionary<string>, headers: IStringDictionary<string>, messageFormatter: IWebsocketMessageFormatter, proxyInfo: ProxyInfo, connectionId?: string)

Parameters

uri
string
queryParameters
IStringDictionary<string>
headers
IStringDictionary<string>
messageFormatter
IWebsocketMessageFormatter
proxyInfo
ProxyInfo
connectionId
string

Property Details

dispose

dispose: () => void

Property Value

() => void

events

events: EventSource<ConnectionEvent>

Property Value

id

id: string

Property Value

string

isDisposed

isDisposed: () => boolean

Property Value

() => boolean

open

open: () => Promise<ConnectionOpenResponse>

Property Value

() => Promise<ConnectionOpenResponse>

read

read: () => Promise<ConnectionMessage>

Property Value

() => Promise<ConnectionMessage>

send

send: (message: ConnectionMessage) => Promise<boolean>

Property Value

(message: ConnectionMessage) => Promise<boolean>

state

state: () => ConnectionState

Property Value

() => ConnectionState