Class CentrifugeDriver

Centrifuge-based signaling driver.

This driver uses Centrifugo as the underlying messaging system, allowing signaling messages to be exchanged through a Centrifuge-based server.

This driver requires the centrifuge module in the browser.

Example

import { Centrifuge } from "centrifuge";

// connect to a Centrifuge server
const centrifuge = new Centrifuge("ws://localhost:8000/connection/websocket");
centrifuge.connect();

// create a new driver instance
const driver = new CentrifugeDriver({ centrifuge });

Running a Centrifugo server locally for testing:

docker run --rm --ulimit nofile=65536:65536 -p 8000:8000 \
  -e CENTRIFUGO_CLIENT_ALLOWED_ORIGINS="*" \
  -e CENTRIFUGO_CLIENT_INSECURE=true \
  centrifugo/centrifugo centrifugo

Hierarchy (View Summary)

Driver
- CentrifugeDriver

Index

Constructors

constructor

new CentrifugeDriver(
options: { centrifuge: CentrifugeClient; prefix?: string },
): CentrifugeDriver
Creates a new instance of the driver.
Parameters
- options: { centrifuge: CentrifugeClient; prefix?: string }
  Optional configuration for the driver.
  - centrifuge: CentrifugeClient
    The Centrifuge client instance.
  - Optionalprefix?: string
    Optional prefix for Centrifuge channels.
Returns CentrifugeDriver
Overrides Driver.constructor
- Defined in src/drivers/centrifuge.ts:52

Accessors

active

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

Returns boolean
Inherited from Driver.active
- Defined in src/drivers/driver.ts:47
set active(value: boolean): void
Sets the active state of the driver and emits corresponding events.
Parameters
- value: boolean
Returns void
Inherited from Driver.active
- Defined in src/drivers/driver.ts:52

Methods

destroy

destroy(): void
Destroys the driver instance, cleaning up any resources.

Returns void
Overrides Driver.destroy
- Defined in src/drivers/centrifuge.ts:154

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
Inherited from Driver.emit
- Defined in src/drivers/driver.ts:99

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
Inherited from Driver.off
- Defined in src/drivers/driver.ts:86

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
Inherited from Driver.on
- Defined in src/drivers/driver.ts:73

publish

publish(namespace: string[], data: number[]): Promise<void>
Publishes a signaling message to the specified namespace.
Parameters
- namespace: string[]
  The namespace to publish the message to.
- data: number[]
  The message data to publish.
Returns Promise<void>
Overrides Driver.publish
- Defined in src/drivers/centrifuge.ts:147

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

unsubscribe

unsubscribe(
namespace: string[],
handler: (data: number[]) => void,
): Promise<void>
Unsubscribes from signaling messages for the specified namespace.
Parameters
- namespace: string[]
  The namespace to unsubscribe from.
- handler: (data: number[]) => void
  The handler function to remove.
Returns Promise<void>
Overrides Driver.unsubscribe
- Defined in src/drivers/centrifuge.ts:129

Class CentrifugeDriver

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

centrifuge: CentrifugeClient

Optionalprefix?: string

Returns CentrifugeDriver

Accessors

active

Returns boolean

Parameters

Returns void

Methods

destroy

Returns void

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

publish

Parameters

Returns Promise<void>

subscribe

Parameters

Returns Promise<void>

unsubscribe

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`prefix?: string