@terascope/teraslice-messaging / messenger/server / Server

Class: Server

Defined in: messenger/server.ts:24

Extends

• Core

Extended by

• Server
• Server

Constructors

Constructor

new Server(opts): Server

Defined in: messenger/server.ts:33

Parameters

Parameter	Type
opts	ServerOptions

Returns

Server

Overrides

Core.constructor

Properties

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

Accessors

availableClientCount

Get Signature

get availableClientCount(): number

Defined in: messenger/server.ts:212

Returns

number

---

availableClients

Get Signature

get availableClients(): ConnectedClient[]

Defined in: messenger/server.ts:208

Returns

ConnectedClient[]

---

disconnectedClientCount

Get Signature

get disconnectedClientCount(): number

Defined in: messenger/server.ts:204

Returns

number

---

disconnectedClients

Get Signature

get disconnectedClients(): ConnectedClient[]

Defined in: messenger/server.ts:200

Returns

ConnectedClient[]

---

onlineClientCount

Get Signature

get onlineClientCount(): number

Defined in: messenger/server.ts:196

Returns

number

---

onlineClients

Get Signature

get onlineClients(): ConnectedClient[]

Defined in: messenger/server.ts:192

Returns

ConnectedClient[]

---

unavailableClientCount

Get Signature

get unavailableClientCount(): number

Defined in: messenger/server.ts:220

Returns

number

---

unavailableClients

Get Signature

get unavailableClients(): ConnectedClient[]

Defined in: messenger/server.ts:216

Returns

ConnectedClient[]

Methods

close()

close(): void

Defined in: messenger/core.ts:39

Returns

void

Inherited from

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

Core.emit

---

ensureClient()

protected ensureClient(socket): ConnectedClient

Defined in: messenger/server.ts:385

Parameters

Parameter	Type
socket	Socket<ClientToServerEvents, ServerToClientEvents>

Returns

ConnectedClient

---

getClientMetadataFromSocket()

protected getClientMetadataFromSocket(socket): ClientSocketMetadata

Defined in: messenger/server.ts:329

Parameters

Parameter	Type
socket	Socket<ClientToServerEvents, ServerToClientEvents>

Returns

ClientSocketMetadata

---

getTimeout()

getTimeout(timeout?): number

Defined in: messenger/core.ts:156

Parameters

Parameter	Type
timeout?	number

Returns

number

Inherited from

Core.getTimeout

---

getTimeoutWithMax()

getTimeoutWithMax(maxTimeout): number

Defined in: messenger/core.ts:151

Parameters

Parameter	Type
maxTimeout	number

Returns

number

Inherited from

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

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

Core.handleSendResponse

---

isClientConnected()

isClientConnected(clientId): boolean

Defined in: messenger/server.ts:323

Parameters

Parameter	Type
clientId	string

Returns

boolean

---

isClientReady()

isClientReady(clientId): boolean

Defined in: messenger/server.ts:266

Parameters

Parameter	Type
clientId	string

Returns

boolean

Overrides

Core.isClientReady

---

listen()

listen(): Promise<void>

Defined in: messenger/server.ts:90

Returns

Promise<void>

---

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

Core.onceWithTimeout

---

onClientAvailable()

onClientAvailable(fn): this

Defined in: messenger/server.ts:230

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientDisconnect()

onClientDisconnect(fn): this

Defined in: messenger/server.ts:242

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientError()

onClientError(fn): this

Defined in: messenger/server.ts:260

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientOnline()

onClientOnline(fn): this

Defined in: messenger/server.ts:224

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientReconnect()

onClientReconnect(fn): this

Defined in: messenger/server.ts:254

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientShutdown()

onClientShutdown(fn): this

Defined in: messenger/server.ts:248

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

onClientUnavailable()

onClientUnavailable(fn): this

Defined in: messenger/server.ts:236

Parameters

Parameter	Type
fn	(clientId) => void

Returns

this

---

send()

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

Defined in: messenger/server.ts:282

Parameters

Parameter	Type
clientId	string
eventName	string
payload	Payload
options	SendOptions

Returns

Promise<Message | null>

---

sendToAll()

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

Defined in: messenger/server.ts:271

Parameters

Parameter	Type
eventName	string
payload?	Payload
options?	SendOptions

Returns

Promise<(Message | null)[]>

---

shutdown()

shutdown(): Promise<void>

Defined in: messenger/server.ts:170

Returns

Promise<void>

---

updateClientState()

protected updateClientState(clientId, state): boolean

Defined in: messenger/server.ts:352

Parameters

Parameter	Type
clientId	string
state	ClientState

Returns

boolean

---

waitForClientReady()

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

Defined in: messenger/core.ts:137

Parameters

Parameter	Type
clientId	string
timeout?	number

Returns

Promise<boolean>

Inherited from

Core.waitForClientReady