@terascope/teraslice-messaging / messenger/core / Core

Class: Core

Defined in: messenger/core.ts:12

Extends

• EventEmitter

Extended by

• Client
• Server

Constructors

new Core()

new Core(opts): Core

Defined in: messenger/core.ts:19

Parameters

Parameter	Type
opts	CoreOptions

Returns

Core

Overrides

EventEmitter.constructor

Properties

Property	Modifier	Type	Default value	Defined in
actionTimeout	protected	number	undefined	messenger/core.ts:16
closed	public	boolean	false	messenger/core.ts:13
logger	protected	Logger	undefined	messenger/core.ts:17
networkLatencyBuffer	protected	number	undefined	messenger/core.ts:15

Methods

close()

close(): void

Defined in: messenger/core.ts:39

Returns

void

---

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

Overrides

EventEmitter.emit

---

getTimeout()

getTimeout(timeout?): number

Defined in: messenger/core.ts:156

Parameters

Parameter	Type
timeout?	number

Returns

number

---

getTimeoutWithMax()

getTimeoutWithMax(maxTimeout): number

Defined in: messenger/core.ts:151

Parameters

Parameter	Type
maxTimeout	number

Returns

number

---

handleResponse()

protected handleResponse(socket, eventName, fn): void

Defined in: messenger/core.ts:93

Parameters

Parameter	Type
socket	SocketEmitter
eventName	string
fn	MessageHandler

Returns

void

---

handleSendResponse()

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

Defined in: messenger/core.ts:44

Parameters

Parameter	Type	Default value
sent	Message	undefined
sendAbortSignal	boolean	false

Returns

Promise<null | Message>

---

isClientReady()

isClientReady(clientId?): boolean

Defined in: messenger/core.ts:132

Parameters

Parameter	Type
clientId?	string

Returns

boolean

---

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>

---

waitForClientReady()

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

Defined in: messenger/core.ts:137

Parameters

Parameter	Type
clientId	string
timeout?	number

Returns

Promise<boolean>