@terascope/teraslice-messaging / cluster-master/server / Server

Class: Server

Defined in: cluster-master/server.ts:9

Extends

• Server

Constructors

Constructor

new Server(opts): Server

Defined in: cluster-master/server.ts:12

Parameters

Parameter	Type
opts	ServerOptions

Returns

Server

Overrides

Server.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
_clients	protected	ConnectedClients	undefined	Server._clients	messenger/server.ts:32
actionTimeout	protected	number	undefined	Server.actionTimeout	messenger/core.ts:16
clientDisconnectTimeout	readonly	number	undefined	Server.clientDisconnectTimeout	messenger/server.ts:30
closed	public	boolean	false	Server.closed	messenger/core.ts:13
httpServer	readonly	Server	undefined	Server.httpServer	messenger/server.ts:28
isShuttingDown	public	boolean	undefined	Server.isShuttingDown	messenger/server.ts:25
logger	protected	Logger	undefined	Server.logger	messenger/core.ts:17
networkLatencyBuffer	protected	number	undefined	Server.networkLatencyBuffer	messenger/core.ts:15
port	readonly	number	undefined	Server.port	messenger/server.ts:26
server	readonly	Server<ClientToServerEvents, ServerToClientEvents>	undefined	Server.server	messenger/server.ts:27
serverName	readonly	string	undefined	Server.serverName	messenger/server.ts:29

Accessors

availableClientCount

Get Signature

get availableClientCount(): number

Defined in: messenger/server.ts:218

Returns

number

Inherited from

Server.availableClientCount

---

availableClients

Get Signature

get availableClients(): ConnectedClient[]

Defined in: messenger/server.ts:214

Returns

ConnectedClient[]

Inherited from

Server.availableClients

---

disconnectedClientCount

Get Signature

get disconnectedClientCount(): number

Defined in: messenger/server.ts:210

Returns

number

Inherited from

Server.disconnectedClientCount

---

disconnectedClients

Get Signature

get disconnectedClients(): ConnectedClient[]

Defined in: messenger/server.ts:206

Returns

ConnectedClient[]

Inherited from

Server.disconnectedClients

---

onlineClientCount

Get Signature

get onlineClientCount(): number

Defined in: messenger/server.ts:202

Returns

number

Inherited from

Server.onlineClientCount

---

onlineClients

Get Signature

get onlineClients(): ConnectedClient[]

Defined in: messenger/server.ts:198

Returns

ConnectedClient[]

Inherited from

Server.onlineClients

---

unavailableClientCount

Get Signature

get unavailableClientCount(): number

Defined in: messenger/server.ts:226

Returns

number

Inherited from

Server.unavailableClientCount

---

unavailableClients

Get Signature

get unavailableClients(): ConnectedClient[]

Defined in: messenger/server.ts:222

Returns

ConnectedClient[]

Inherited from

Server.unavailableClients

Methods

close()

close(): void

Defined in: messenger/core.ts:39

Returns

void

Inherited from

Server.close

---

emit()

emit(eventName, msg): void

Defined in: messenger/core.ts:161

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	EventMessage

Returns

void

Since

v0.1.26

Inherited from

Server.emit

---

ensureClient()

protected ensureClient(socket): ConnectedClient

Defined in: messenger/server.ts:391

Parameters

Parameter	Type
socket	Socket<ClientToServerEvents, ServerToClientEvents>

Returns

ConnectedClient

Inherited from

Server.ensureClient

---

getClientMetadataFromSocket()

protected getClientMetadataFromSocket(socket): ClientSocketMetadata

Defined in: messenger/server.ts:335

Parameters

Parameter	Type
socket	Socket<ClientToServerEvents, ServerToClientEvents>

Returns

ClientSocketMetadata

Inherited from

Server.getClientMetadataFromSocket

---

getClusterAnalytics()

getClusterAnalytics(): ClusterAnalytics

Defined in: cluster-master/server.ts:78

Returns

ClusterAnalytics

---

getTimeout()

getTimeout(timeout?): number

Defined in: messenger/core.ts:156

Parameters

Parameter	Type
timeout?	number

Returns

number

Inherited from

Server.getTimeout

---

getTimeoutWithMax()

getTimeoutWithMax(maxTimeout): number

Defined in: messenger/core.ts:151

Parameters

Parameter	Type
maxTimeout	number

Returns

number

Inherited from

Server.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

Server.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

Server.handleSendResponse

---

isClientConnected()

isClientConnected(clientId): boolean

Defined in: messenger/server.ts:329

Parameters

Parameter	Type
clientId	string

Returns

boolean

Inherited from

Server.isClientConnected

---

isClientReady()

isClientReady(clientId): boolean

Defined in: messenger/server.ts:272

Parameters

Parameter	Type
clientId	string

Returns

boolean

Inherited from

Server.isClientReady

---

listen()

listen(): Promise<void>

Defined in: messenger/server.ts:96

Returns

Promise<void>

Inherited from

Server.listen

---

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

Server.onceWithTimeout

---

onClientAvailable()

onClientAvailable(fn): this

Defined in: messenger/server.ts:236

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientAvailable

---

onClientDisconnect()

onClientDisconnect(fn): this

Defined in: messenger/server.ts:248

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientDisconnect

---

onClientError()

onClientError(fn): this

Defined in: messenger/server.ts:266

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientError

---

onClientOnline()

onClientOnline(fn): this

Defined in: messenger/server.ts:230

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientOnline

---

onClientReconnect()

onClientReconnect(fn): this

Defined in: messenger/server.ts:260

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientReconnect

---

onClientShutdown()

onClientShutdown(fn): this

Defined in: messenger/server.ts:254

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientShutdown

---

onClientUnavailable()

onClientUnavailable(fn): this

Defined in: messenger/server.ts:242

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

Inherited from

Server.onClientUnavailable

---

onExecutionFinished()

onExecutionFinished(fn): void

Defined in: cluster-master/server.ts:82

Parameters

Parameter	Type
fn	(clientId, error?) => void

Returns

void

---

send()

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

Defined in: messenger/server.ts:288

Parameters

Parameter	Type
clientId	string
eventName	string
payload	Payload
options	SendOptions

Returns

Promise<Message | null>

Inherited from

Server.send

---

sendExecutionAnalyticsRequest()

sendExecutionAnalyticsRequest(exId): Promise<Message | null>

Defined in: cluster-master/server.ts:74

Parameters

Parameter	Type
exId	string

Returns

Promise<Message | null>

---

sendExecutionLogLevel()

sendExecutionLogLevel(exId, level): Promise<Message | null>

Defined in: cluster-master/server.ts:70

Parameters

Parameter	Type
exId	string
level	string

Returns

Promise<Message | null>

---

sendExecutionPause()

sendExecutionPause(exId): Promise<Message | null>

Defined in: cluster-master/server.ts:62

Parameters

Parameter	Type
exId	string

Returns

Promise<Message | null>

---

sendExecutionResume()

sendExecutionResume(exId): Promise<Message | null>

Defined in: cluster-master/server.ts:66

Parameters

Parameter	Type
exId	string

Returns

Promise<Message | null>

---

sendToAll()

protected sendToAll(eventName, payload?, options?): Promise<(Message | null)[]>

Defined in: messenger/server.ts:277

Parameters

Parameter	Type
eventName	string
payload?	Payload
options?	SendOptions

Returns

Promise<(Message | null)[]>

Inherited from

Server.sendToAll

---

shutdown()

shutdown(): Promise<void>

Defined in: messenger/server.ts:176

Returns

Promise<void>

Inherited from

Server.shutdown

---

start()

start(): Promise<void>

Defined in: cluster-master/server.ts:51

Returns

Promise<void>

---

updateClientState()

protected updateClientState(clientId, state): boolean

Defined in: messenger/server.ts:358

Parameters

Parameter	Type
clientId	string
state	ClientState

Returns

boolean

Inherited from

Server.updateClientState

---

waitForClientReady()

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

Defined in: messenger/core.ts:137

Parameters

Parameter	Type
clientId	string
timeout?	number

Returns

Promise<boolean>

Inherited from

Server.waitForClientReady