@terascope/teraslice-messaging / execution-controller/client / Client

Class: Client

Defined in: execution-controller/client.ts:8

Extends

• Client

Constructors

Constructor

new Client(opts): Client

Defined in: execution-controller/client.ts:11

Parameters

Parameter	Type
opts	ClientOptions

Returns

Client

Overrides

Client.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
actionTimeout	protected	number	undefined	Client.actionTimeout	messenger/core.ts:16
available	public	boolean	undefined	Client.available	messenger/client.ts:25
clientId	readonly	string	undefined	Client.clientId	messenger/client.ts:20
clientType	readonly	string	undefined	Client.clientType	messenger/client.ts:21
closed	public	boolean	false	Client.closed	messenger/core.ts:13
connectTimeout	readonly	number	undefined	Client.connectTimeout	messenger/client.ts:23
hostUrl	readonly	string	undefined	Client.hostUrl	messenger/client.ts:24
logger	protected	Logger	undefined	Client.logger	messenger/core.ts:17
networkLatencyBuffer	protected	number	undefined	Client.networkLatencyBuffer	messenger/core.ts:15
ready	public	boolean	undefined	Client.ready	messenger/client.ts:26
serverName	readonly	string	undefined	Client.serverName	messenger/client.ts:22
serverShutdown	protected	boolean	undefined	Client.serverShutdown	messenger/client.ts:27
socket	readonly	Socket<ServerToClientEvents, ClientToServerEvents>	undefined	Client.socket	messenger/client.ts:19
workerId	public	string	undefined	-	execution-controller/client.ts:9

Methods

close()

close(): void

Defined in: messenger/core.ts:39

Returns

void

Inherited from

Client.close

---

connect()

connect(): Promise<void>

Defined in: messenger/client.ts:115

Returns

Promise<void>

Inherited from

Client.connect

---

emit()

emit(eventName, msg?): void

Defined in: messenger/client.ts:304

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Parameters

Parameter	Type
eventName	string
msg	ClientEventMessage

Returns

void

Since

v0.1.26

Inherited from

Client.emit

---

forceReconnect()

forceReconnect(): Promise<void>

Defined in: messenger/client.ts:340

Returns

Promise<void>

Inherited from

Client.forceReconnect

---

getTimeout()

getTimeout(timeout?): number

Defined in: messenger/core.ts:156

Parameters

Parameter	Type
timeout?	number

Returns

number

Inherited from

Client.getTimeout

---

getTimeoutWithMax()

getTimeoutWithMax(maxTimeout): number

Defined in: messenger/core.ts:151

Parameters

Parameter	Type
maxTimeout	number

Returns

number

Inherited from

Client.getTimeoutWithMax

---

handleResponse()

protected handleResponse(socket, eventName, fn): void

Defined in: messenger/core.ts:93

Parameters

Parameter	Type
socket	SocketEmitter
eventName	string
fn	MessageHandler

Returns

void

Inherited from

Client.handleResponse

---

handleSendResponse()

protected handleSendResponse(sent, sendAbortSignal?): Promise<Message | null>

Defined in: messenger/core.ts:44

Parameters

Parameter	Type	Default value
sent	Message	undefined
sendAbortSignal	boolean	false

Returns

Promise<Message | null>

Inherited from

Client.handleSendResponse

---

isClientReady()

isClientReady(): boolean

Defined in: messenger/client.ts:309

Returns

boolean

Inherited from

Client.isClientReady

---

onceWithTimeout()

onceWithTimeout(eventName, timeout?, abortSignal?): Promise<any>

Defined in: messenger/core.ts:168

Parameters

Parameter	Type
eventName	string
timeout?	number
abortSignal?	AbortSignal

Returns

Promise<any>

Inherited from

Client.onceWithTimeout

---

onExecutionFinished()

onExecutionFinished(fn): void

Defined in: execution-controller/client.ts:74

Parameters

Parameter	Type
fn	() => void

Returns

void

---

onServerShutdown()

onServerShutdown(fn): void

Defined in: messenger/client.ts:101

Parameters

Parameter	Type
fn	() => void

Returns

void

Inherited from

Client.onServerShutdown

---

onSliceTapRequest()

onSliceTapRequest(fn): void

Defined in: execution-controller/client.ts:78

Parameters

Parameter	Type
fn	MessageHandler

Returns

void

---

send()

protected send(eventName, payload?, options?): Promise<Message | null>

Defined in: messenger/client.ts:266

Parameters

Parameter	Type
eventName	string
payload	Payload
options	SendOptions

Returns

Promise<Message | null>

Inherited from

Client.send

---

sendAvailable()

sendAvailable(payload?): Promise<Message | null | undefined>

Defined in: messenger/client.ts:248

Parameters

Parameter	Type
payload?	Payload

Returns

Promise<Message | null | undefined>

Inherited from

Client.sendAvailable

---

sendSliceComplete()

sendSliceComplete(payload): Promise<Message | null>

Defined in: execution-controller/client.ts:82

Parameters

Parameter	Type
payload	SliceCompletePayload

Returns

Promise<Message | null>

---

sendUnavailable()

sendUnavailable(payload?): Promise<Message | null | undefined>

Defined in: messenger/client.ts:257

Parameters

Parameter	Type
payload?	Payload

Returns

Promise<Message | null | undefined>

Inherited from

Client.sendUnavailable

---

shutdown()

shutdown(): Promise<void>

Defined in: messenger/client.ts:313

Returns

Promise<void>

Inherited from

Client.shutdown

---

start()

start(): Promise<void>

Defined in: execution-controller/client.ts:46

Returns

Promise<void>

---

waitForClientReady()

waitForClientReady(clientId, timeout?): Promise<boolean>

Defined in: messenger/core.ts:137

Parameters

Parameter	Type
clientId	string
timeout?	number

Returns

Promise<boolean>

Inherited from

Client.waitForClientReady

---

waitForSlice()

waitForSlice(fn?, timeoutMs?): Promise<Slice | undefined>

Defined in: execution-controller/client.ts:90

Parameters

Parameter	Type
fn	WaitUntilFn
timeoutMs	number

Returns

Promise<Slice | undefined>