BaseConnection

Defined in: packages/core/src/data/streaming/base-connection.ts:105

Abstract base class for streaming connections.

Remarks

Provides common functionality for all streaming connection types:

Connection state management
Event emission via EventEmitter
Automatic reconnection with exponential backoff
State change tracking

Subclasses must implement:

connect(): Establish the connection
disconnect(): Close the connection

Example

class MyConnection extends BaseConnection {
  async connect(): Promise<void> {
    this.setState('connecting');
    // ... connection logic
    this.setState('connected');
    this.emit('connect', undefined);
  }

  disconnect(): void {
    // ... disconnection logic
    this.handleDisconnect('Manual disconnect');
  }
}

Extends

EventEmitter<ConnectionEvents>

Extended by

Constructors

Constructor

new BaseConnection(config): BaseConnection

Defined in: packages/core/src/data/streaming/base-connection.ts:117

Create a new base connection.

Parameters

Parameter	Type	Description
`config`	`ConnectionConfig`	Connection configuration

Returns

BaseConnection

Overrides

EventEmitter.constructor

Methods

connect()

abstract connect(): Promise<void>

Defined in: packages/core/src/data/streaming/base-connection.ts:150

Establish connection to the server.

Returns

Promise<void>

Remarks

Must be implemented by subclasses. Should:

Set state to ‘connecting’
Establish the connection
Set state to ‘connected’
Emit ‘connect’ event

Throws

Error if connection fails

disconnect()

abstract disconnect(): void

Defined in: packages/core/src/data/streaming/base-connection.ts:160

Close the connection.

Returns

void

Remarks

Must be implemented by subclasses. Should:

Close the underlying connection
Call handleDisconnect() with reason

eventNames()

eventNames(): keyof ConnectionEvents[]

Defined in: packages/core/src/utils/event-emitter.ts:211

Get all event names that have registered handlers

Returns

keyof ConnectionEvents[]

Array of event names

Example

const events = emitter.eventNames();
console.log('Events with handlers:', events);

Inherited from

EventEmitter.eventNames

getReconnectAttempts()

getReconnectAttempts(): number

Defined in: packages/core/src/data/streaming/base-connection.ts:200

Get the number of reconnection attempts.

Returns

number

Number of reconnect attempts

getState()

getState(): ConnectionState

Defined in: packages/core/src/data/streaming/base-connection.ts:175

Get current connection state.

Returns

ConnectionState

Current state

Example

const state = connection.getState();
if (state === 'connected') {
  // Connection is ready
}

hasListeners()

hasListeners<K>(event): boolean

Defined in: packages/core/src/utils/event-emitter.ts:228

Check if an event has any registered handlers

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event`	`K`	Event name

Returns

boolean

True if the event has at least one handler

Example

if (emitter.hasListeners('message')) {
  emitter.emit('message', { text: 'Hello' });
}

Inherited from

EventEmitter.hasListeners

isConnected()

isConnected(): boolean

Defined in: packages/core/src/data/streaming/base-connection.ts:191

Check if connection is currently connected.

Returns

boolean

True if connected

Example

if (connection.isConnected()) {
  connection.send(data);
}

listenerCount()

listenerCount<K>(event): number

Defined in: packages/core/src/utils/event-emitter.ts:195

Get the number of handlers registered for an event

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event`	`K`	Event name

Returns

number

Number of registered handlers

Example

const count = emitter.listenerCount('message');
console.log(`${count} handlers registered`);

Inherited from

EventEmitter.listenerCount

off()

off<K>(event, handler): void

Defined in: packages/core/src/utils/event-emitter.ts:120

Remove an event handler

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event`	`K`	Event name
`handler`	`EventHandler`<`ConnectionEvents`[`K`]>	Handler function to remove

Returns

void

Example

const handler = (data) => console.log(data);
emitter.on('message', handler);
emitter.off('message', handler);

Inherited from

EventEmitter.off

on()

on<K>(event, handler): () => void

Defined in: packages/core/src/utils/event-emitter.ts:65

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event`	`K`	Event name to listen for
`handler`	`EventHandler`<`ConnectionEvents`[`K`]>	Callback function to invoke when event is emitted

Returns

Unsubscribe function that removes this specific handler

() => void

Example

const unsubscribe = emitter.on('message', (data) => {
  console.log(data.text);
});

// Later, to unsubscribe:
unsubscribe();

Inherited from

EventEmitter.on

once()

once<K>(event, handler): void

Defined in: packages/core/src/utils/event-emitter.ts:95

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event`	`K`	Event name to listen for
`handler`	`EventHandler`<`ConnectionEvents`[`K`]>	Callback function to invoke once

Returns

void

Remarks

The handler will be automatically removed after being invoked once.

Example

emitter.once('connect', () => {
  console.log('Connected!');
});

Inherited from

EventEmitter.once

removeAllListeners()

removeAllListeners<K>(event?): void

Defined in: packages/core/src/utils/event-emitter.ts:175

Remove all handlers for an event, or all handlers for all events

Type Parameters

Type Parameter
`K` extends keyof `ConnectionEvents`

Parameters

Parameter	Type	Description
`event?`	`K`	Optional event name. If omitted, removes all handlers for all events.

Returns

void

Example

// Remove all handlers for 'message' event
emitter.removeAllListeners('message');

// Remove all handlers for all events
emitter.removeAllListeners();

Inherited from

EventEmitter.removeAllListeners