Class Driver

Base class for signaling drivers.

Drivers are responsible for sending and receiving signaling messages between peers. They should implement the subscribe, unsubscribe and dispatch methods to handle message routing based on namespaces.

Example

class MyDriver extends Driver {
  async subscribe(namespace, handler) {
    // subscribe to messages for the given namespace and call handler on message
  }

  async unsubscribe(namespace, handler) {
    // unsubscribe from messages for the given namespace and handler
  }

  async dispatch(namespace, message) {
    // dispatch a message to the given namespace
  }
}

Hierarchy (View Summary)

Driver

Index

Constructors

constructor

new Driver(): Driver
Creates a new driver instance.

Returns Driver
- Defined in src/drivers/driver.ts:48

Accessors

active

get active(): boolean
Indicates whether the driver is currently active.

Returns boolean
- Defined in src/drivers/driver.ts:33
set active(value: boolean): void
Sets the active state of the driver and emits corresponding events.
Parameters
- value: boolean
Returns void
- Defined in src/drivers/driver.ts:38

Methods

dispatch

dispatch(namespace: string[], message: Uint8Array): Promise<void>
Dispatches a signaling message to the specified namespace.
Parameters
- namespace: string[]
  The namespace to dispatch the message to.
- message: Uint8Array
  The message to dispatch.
Returns Promise<void>
- Defined in src/drivers/driver.ts:108

emit

emit<K extends keyof DriverEvents>(event: K, ...args: DriverEvents[K]): void
Emits an internal event with optional data.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- ...args: DriverEvents[K]
  The data to pass to event handlers.
Returns void
- Defined in src/drivers/driver.ts:78

off

off<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Unregisters an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function to remove.
Returns void
- Defined in src/drivers/driver.ts:68

on

on<K extends keyof DriverEvents>(
event: K,
handler: (...args: DriverEvents[K]) => void,
): void
Registers an event handler for the specified internal event.
Type Parameters
- K extends keyof DriverEvents
Parameters
- event: K
  The event name.
- handler: (...args: DriverEvents[K]) => void
  The event handler function.
Returns void
- Defined in src/drivers/driver.ts:58

subscribe(
namespace: string[],
handler: (message: Uint8Array) => void,
): Promise<void>
Subscribes to signaling messages for the specified namespace.
Parameters
- namespace: string[]
  The namespace to subscribe to.
- handler: (message: Uint8Array) => void
  The handler function to call when a message is received.
Returns Promise<void>
- Defined in src/drivers/driver.ts:88

unsubscribe

unsubscribe(
namespace: string[],
handler: (message: Uint8Array) => void,
): Promise<void>
Unsubscribes from signaling messages for the specified namespace.
Parameters
- namespace: string[]
  The namespace to unsubscribe from.
- handler: (message: Uint8Array) => void
  The handler function to remove.
Returns Promise<void>
- Defined in src/drivers/driver.ts:98

Class Driver

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Driver

Accessors

active

Returns boolean

Parameters

Returns void

Methods

dispatch

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Parameters

Returns Promise<void>

unsubscribe

Parameters

Returns Promise<void>

Settings

On This Page