Class WebSocketManagerClient

Index

Constructors

Methods

connect disconnect getTag getTags list send sendRaw setTag setTags startPublish stopPublish

Constructors

constructor

new WebSocketManagerClient(
options: WebSocketManagerClientOptions,
): WebSocketManagerClient
Parameters
- options: WebSocketManagerClientOptions
Returns WebSocketManagerClient
- Defined in client.ts:39

Methods

connect

connect(url: string, autoReconnect?: boolean): Promise<ConnectResponse>
Parameters
- url: string
- OptionalautoReconnect: boolean
Returns Promise<ConnectResponse>
- Defined in client.ts:45

disconnect

disconnect(id: string): Promise<Message<"virtufin.DisconnectResponse">>
Parameters
- id: string
Returns Promise<Message<"virtufin.DisconnectResponse">>
- Defined in client.ts:56

getTag

getTag(id: string, key: string): Promise<GetTagResponse>
Parameters
- id: string
- key: string
Returns Promise<GetTagResponse>
- Defined in client.ts:85

getTags

getTags(id: string): Promise<GetTagsResponse>
Parameters
- id: string
Returns Promise<GetTagsResponse>
- Defined in client.ts:93

list

list(): Promise<ListResponse>
Returns Promise<ListResponse>
- Defined in client.ts:52

send

send(
    id: string,
    message: Uint8Array,
    contentType: string,
    timeoutMs?: number,
): Promise<SendResponse>
Parameters
- id: string
- message: Uint8Array
- contentType: string
- OptionaltimeoutMs: number
Returns Promise<SendResponse>
- Defined in client.ts:60

sendRaw

sendRaw(
    id: string,
    message: Uint8Array,
    contentType: string,
): Promise<Message<"virtufin.SendRawResponse">>
Parameters
- id: string
- message: Uint8Array
- contentType: string
Returns Promise<Message<"virtufin.SendRawResponse">>
- Defined in client.ts:69

setTag

setTag(
    id: string,
    key: string,
    value: string,
): Promise<Message<"virtufin.SetTagResponse">>
Parameters
- id: string
- key: string
- value: string
Returns Promise<Message<"virtufin.SetTagResponse">>
- Defined in client.ts:81

setTags

setTags(
id: string,
tags: Record<string, string>,
): Promise<Message<"virtufin.SetTagsResponse">>
Parameters
- id: string
- tags: Record<string, string>
Returns Promise<Message<"virtufin.SetTagsResponse">>
- Defined in client.ts:89

startPublish

startPublish(
id: string,
topic: string,
): Promise<Message<"virtufin.StartPublishResponse">>
Parameters
- id: string
- topic: string
Returns Promise<Message<"virtufin.StartPublishResponse">>
- Defined in client.ts:73

stopPublish

stopPublish(id: string): Promise<Message<"virtufin.StopPublishResponse">>
Parameters
- id: string
Returns Promise<Message<"virtufin.StopPublishResponse">>
- Defined in client.ts:77