Teraslice Messaging: `Messenger Client Client`
messenger/client.Client
Hierarchy
Table of contents
Constructors
Properties
- actionTimeout
- available
- clientId
- clientType
- closed
- connectTimeout
- hostUrl
- logger
- networkLatencyBuffer
- ready
- serverName
- serverShutdown
- socket
Methods
- close
- connect
- emit
- forceReconnect
- getTimeout
- getTimeoutWithMax
- handleResponse
- handleSendResponse
- isClientReady
- onServerShutdown
- onceWithTimeout
- send
- sendAvailable
- sendUnavailable
- shutdown
- waitForClientReady
Constructors
constructor
• new Client(opts
, _connectTimeout?
): Client
Parameters
Name | Type |
---|---|
opts | ClientOptions |
_connectTimeout? | number |
Returns
Overrides
Defined in
Properties
actionTimeout
• Protected
actionTimeout: number
Inherited from
Defined in
available
• available: boolean
Defined in
clientId
• Readonly
clientId: string
Defined in
clientType
• Readonly
clientType: string
Defined in
closed
• closed: boolean
= false
Inherited from
Defined in
connectTimeout
• Readonly
connectTimeout: number
Defined in
hostUrl
• Readonly
hostUrl: string
Defined in
logger
• Protected
logger: Logger
Inherited from
Defined in
networkLatencyBuffer
• Protected
networkLatencyBuffer: number
Inherited from
Defined in
ready
• ready: boolean
Defined in
serverName
• Readonly
serverName: string
Defined in
serverShutdown
• Protected
serverShutdown: boolean
Defined in
socket
• Readonly
socket: Socket
Defined in
Methods
close
▸ close(): void
Returns
void
Inherited from
Defined in
connect
▸ connect(): Promise
<void
>
Returns
Promise
<void
>
Defined in
emit
▸ emit(eventName
, msg?
): void
Parameters
Name | Type |
---|---|
eventName | string |
msg | ClientEventMessage |
Returns
void
Overrides
Defined in
forceReconnect
▸ forceReconnect(): Promise
<void
>
Returns
Promise
<void
>
Defined in
getTimeout
▸ getTimeout(timeout?
): number
Parameters
Name | Type |
---|---|
timeout? | number |
Returns
number
Inherited from
Defined in
getTimeoutWithMax
▸ getTimeoutWithMax(maxTimeout
): number
Parameters
Name | Type |
---|---|
maxTimeout | number |
Returns
number
Inherited from
Defined in
handleResponse
▸ handleResponse(socket
, eventName
, fn
): void
Parameters
Name | Type |
---|---|
socket | SocketEmitter |
eventName | string |
fn | MessageHandler |
Returns
void
Inherited from
Defined in
handleSendResponse
▸ handleSendResponse(sent
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
sent | Message |
Returns
Promise
<null
| Message
>
Inherited from
Defined in
isClientReady
▸ isClientReady(): boolean
Returns
boolean
Overrides
Defined in
onServerShutdown
▸ onServerShutdown(fn
): void
Parameters
Name | Type |
---|---|
fn | () => void |
Returns
void
Defined in
onceWithTimeout
▸ onceWithTimeout(eventName
, timeout?
): Promise
<any
>
Parameters
Name | Type |
---|---|
eventName | string |
timeout? | number |
Returns
Promise
<any
>
Inherited from
Defined in
send
▸ send(eventName
, payload?
, options?
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
eventName | string |
payload | Payload |
options | SendOptions |
Returns
Promise
<null
| Message
>
Defined in
sendAvailable
▸ sendAvailable(payload?
): Promise
<undefined
| null
| Message
>
Parameters
Name | Type |
---|---|
payload? | Payload |
Returns
Promise
<undefined
| null
| Message
>
Defined in
sendUnavailable
▸ sendUnavailable(payload?
): Promise
<undefined
| null
| Message
>
Parameters
Name | Type |
---|---|
payload? | Payload |
Returns
Promise
<undefined
| null
| Message
>
Defined in
shutdown
▸ shutdown(): Promise
<void
>
Returns
Promise
<void
>
Defined in
waitForClientReady
▸ waitForClientReady(clientId
, timeout?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
clientId | string |
timeout? | number |
Returns
Promise
<boolean
>