Teraslice Messaging: `Execution Controller Client Client`
execution-controller/client.Client
Hierarchy
-
↳
Client
Table of contents
Constructors
Properties
- actionTimeout
- available
- clientId
- clientType
- closed
- connectTimeout
- hostUrl
- logger
- networkLatencyBuffer
- ready
- serverName
- serverShutdown
- socket
- workerId
Methods
- close
- connect
- emit
- forceReconnect
- getTimeout
- getTimeoutWithMax
- handleResponse
- handleSendResponse
- isClientReady
- onExecutionFinished
- onServerShutdown
- onceWithTimeout
- send
- sendAvailable
- sendSliceComplete
- sendUnavailable
- shutdown
- start
- waitForClientReady
- waitForSlice
Constructors
constructor
• new Client(opts
): Client
Parameters
Name | Type |
---|---|
opts | ClientOptions |
Returns
Overrides
Defined in
execution-controller/client.ts:11
Properties
actionTimeout
• Protected
actionTimeout: number
Inherited from
Defined in
available
• available: boolean
Inherited from
Defined in
clientId
• Readonly
clientId: string
Inherited from
Defined in
clientType
• Readonly
clientType: string
Inherited from
Defined in
closed
• closed: boolean
= false
Inherited from
Defined in
connectTimeout
• Readonly
connectTimeout: number
Inherited from
Defined in
hostUrl
• Readonly
hostUrl: string
Inherited from
Defined in
logger
• Protected
logger: Logger
Inherited from
Defined in
networkLatencyBuffer
• Protected
networkLatencyBuffer: number
Inherited from
Defined in
ready
• ready: boolean
Inherited from
Defined in
serverName
• Readonly
serverName: string
Inherited from
Defined in
serverShutdown
• Protected
serverShutdown: boolean
Inherited from
Defined in
socket
• Readonly
socket: Socket
Inherited from
Defined in
workerId
• workerId: string
Defined in
execution-controller/client.ts:9
Methods
close
▸ close(): void
Returns
void
Inherited from
Defined in
connect
▸ connect(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
emit
▸ emit(eventName
, msg?
): void
Parameters
Name | Type |
---|---|
eventName | string |
msg | ClientEventMessage |
Returns
void
Inherited from
Defined in
forceReconnect
▸ forceReconnect(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
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
Inherited from
Defined in
onExecutionFinished
▸ onExecutionFinished(fn
): void
Parameters
Name | Type |
---|---|
fn | () => void |
Returns
void
Defined in
execution-controller/client.ts:80
onServerShutdown
▸ onServerShutdown(fn
): void
Parameters
Name | Type |
---|---|
fn | () => void |
Returns
void
Inherited from
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
>
Inherited from
Defined in
sendAvailable
▸ sendAvailable(payload?
): Promise
<undefined
| null
| Message
>
Parameters
Name | Type |
---|---|
payload? | Payload |
Returns
Promise
<undefined
| null
| Message
>
Inherited from
Defined in
sendSliceComplete
▸ sendSliceComplete(payload
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
payload | SliceCompletePayload |
Returns
Promise
<null
| Message
>
Defined in
execution-controller/client.ts:84
sendUnavailable
▸ sendUnavailable(payload?
): Promise
<undefined
| null
| Message
>
Parameters
Name | Type |
---|---|
payload? | Payload |
Returns
Promise
<undefined
| null
| Message
>
Inherited from
Defined in
shutdown
▸ shutdown(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
start
▸ start(): Promise
<void
>
Returns
Promise
<void
>
Defined in
execution-controller/client.ts:52
waitForClientReady
▸ waitForClientReady(clientId
, timeout?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
clientId | string |
timeout? | number |
Returns
Promise
<boolean
>
Inherited from
Defined in
waitForSlice
▸ waitForSlice(fn?
, timeoutMs?
): Promise
<undefined
| Slice
>
Parameters
Name | Type |
---|---|
fn | WaitUntilFn |
timeoutMs | number |
Returns
Promise
<undefined
| Slice
>