Interface Broker

Broker defines a struct for managing subscriptions clients.

Hierarchy

Broker

Index

Methods

chunkedClients clientById clients register totalClients unregister

Methods

chunkedClients

chunkedClients(chunkSize): Client[][]
ChunkedClients splits the current clients into a chunked slice.
Parameters
- chunkSize: number
Returns Client[][]
- Defined in types.d.ts:20574

clientById

clientById(clientId): Client
ClientById finds a registered client by its id.

Returns non-nil error when client with clientId is not registered.
Parameters
- clientId: string
Returns Client
- Defined in types.d.ts:20588

clients

clients(): _TygojaDict
Clients returns a shallow copy of all registered clients indexed with their connection id.

Returns _TygojaDict
- Defined in types.d.ts:20568

register

register(client): void
Register adds a new client to the broker instance.
Parameters
- client: Client
Returns void
- Defined in types.d.ts:20594

totalClients

totalClients(): number
TotalClients returns the total number of registered clients.

Returns number
- Defined in types.d.ts:20580

unregister

unregister(clientId): void
Unregister removes a single client by its id and marks it as discarded.

If client with clientId doesn't exist, this method does nothing.
Parameters
- clientId: string
Returns void
- Defined in types.d.ts:20602

Generated using TypeDoc