Teraslice Messaging: `Messenger Core Core`
messenger/core.Core
Hierarchy
Table of contents
Constructors
Properties
Methods
- close
- emit
- getTimeout
- getTimeoutWithMax
- handleResponse
- handleSendResponse
- isClientReady
- onceWithTimeout
- waitForClientReady
Constructors
constructor
• new Core(opts
): Core
Parameters
Name | Type |
---|---|
opts | CoreOptions |
Returns
Overrides
EventEmitter.constructor
Defined in
Properties
actionTimeout
• Protected
actionTimeout: number
Defined in
closed
• closed: boolean
= false
Defined in
logger
• Protected
logger: Logger
Defined in
networkLatencyBuffer
• Protected
networkLatencyBuffer: number
Defined in
Methods
close
▸ close(): void
Returns
void
Defined in
emit
▸ emit(eventName
, msg
): void
Parameters
Name | Type |
---|---|
eventName | string |
msg | EventMessage |
Returns
void
Overrides
EventEmitter.emit
Defined in
getTimeout
▸ getTimeout(timeout?
): number
Parameters
Name | Type |
---|---|
timeout? | number |
Returns
number
Defined in
getTimeoutWithMax
▸ getTimeoutWithMax(maxTimeout
): number
Parameters
Name | Type |
---|---|
maxTimeout | number |
Returns
number
Defined in
handleResponse
▸ handleResponse(socket
, eventName
, fn
): void
Parameters
Name | Type |
---|---|
socket | SocketEmitter |
eventName | string |
fn | MessageHandler |
Returns
void
Defined in
handleSendResponse
▸ handleSendResponse(sent
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
sent | Message |
Returns
Promise
<null
| Message
>
Defined in
isClientReady
▸ isClientReady(clientId?
): boolean
Parameters
Name | Type |
---|---|
clientId? | string |
Returns
boolean
Defined in
onceWithTimeout
▸ onceWithTimeout(eventName
, timeout?
): Promise
<any
>
Parameters
Name | Type |
---|---|
eventName | string |
timeout? | number |
Returns
Promise
<any
>
Defined in
waitForClientReady
▸ waitForClientReady(clientId
, timeout?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
clientId | string |
timeout? | number |
Returns
Promise
<boolean
>