Class WebSocketServerTransport

Hierarchy

AbstractTransport
- WebSocketServerTransport

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebSocketServerTransport(options: WebSocketServerTransportOptions): WebSocketServerTransport

Overrides AbstractTransport.constructor
- Defined in packages/ws-server/src/WebSocketServerTransport.ts:21
Create a new instance.

Parameters
- options: WebSocketServerTransportOptions
Returns WebSocketServerTransport

Properties

Protected debug

debug: Debugger

Protected Readonly peers

peers: Set<Peer>

Optional server

server?: Server

Accessors

onPeerConnect

get onPeerConnect(): Subscribable<this, [peer: Peer]>

Inherited from AbstractTransport.onPeerConnect
- Defined in packages/transport/src/AbstractTransport.ts:57
Event for when a new peer is connected via this transport.

Returns Subscribable<this, [peer: Peer]>
Subscribable that can be used to register listeners

started

get started(): boolean

Inherited from AbstractTransport.started
- Defined in packages/transport/src/AbstractTransport.ts:67
Get if transport is started.

Returns boolean
true if transport is started

transportOptions

get transportOptions(): TransportOptions

Inherited from AbstractTransport.transportOptions
- Defined in packages/transport/src/AbstractTransport.ts:43
Returns TransportOptions

Methods

Protected addPeer

addPeer(peer: Peer): void

Inherited from AbstractTransport.addPeer
- Defined in packages/transport/src/AbstractTransport.ts:120
Add a peer to this transport. This will start monitoring this peer for connection events and make it available/unavailable as it connects/disconnects.

Parameters
- peer: Peer
  - peer to track
Returns void

start

start(options: TransportOptions): Promise<boolean>

Overrides AbstractTransport.start
- Defined in packages/ws-server/src/WebSocketServerTransport.ts:31
Start this transport.

Parameters
- options: TransportOptions
Returns Promise<boolean>
boolean indicating if the transport was started

stop

stop(): Promise<boolean>

Overrides AbstractTransport.stop
- Defined in packages/ws-server/src/WebSocketServerTransport.ts:60
Stop this transport.

Returns Promise<boolean>
boolean indicating if the transport was stopped.

Generated using TypeDoc