Skip to main content

QServerEventRoute

@quik/http

@quik/http / QServerEventRoute

Class: QServerEventRoute

Defined in: http/src/router/QServerEventRoute.ts:50

Specialized route used to handle Server Sent Events endpoints.

Extends​

Constructors​

Constructor​

new QServerEventRoute(): QServerEventRoute

Returns​

QServerEventRoute

Inherited from​

QRoute.constructor

Properties​

_basePath​

protected _basePath: string = "/"

Defined in: http/src/router/QRoute.ts:21

Inherited from​

QRoute._basePath

_clients​

protected _clients: QServerEventEndpoints = {}

Defined in: http/src/router/QServerEventRoute.ts:51

_condition​

protected _condition: () => boolean

Defined in: http/src/router/QRoute.ts:9

Returns​

boolean

Inherited from​

QRoute._condition

_endpoints​

protected _endpoints: IQEndpointDefinition[] = []

Defined in: http/src/router/QRoute.ts:27

Inherited from​

QRoute._endpoints

_engineMiddlewares​

protected _engineMiddlewares: unknown[] = []

Defined in: http/src/router/QRoute.ts:39

Inherited from​

QRoute._engineMiddlewares

_flags​

protected _flags: string[] = []

Defined in: http/src/router/QRoute.ts:15

Inherited from​

QRoute._flags

_middlewares​

protected _middlewares: QEndpointMiddleware[] = []

Defined in: http/src/router/QRoute.ts:33

Inherited from​

QRoute._middlewares

Accessors​

basePath​

Get Signature​

get basePath(): string

Defined in: http/src/router/QRoute.ts:23

Returns​

string

Inherited from​

QRoute.basePath

clients​

Get Signature​

get protected clients(): QServerEventEndpoints

Defined in: http/src/router/QServerEventRoute.ts:53

Returns​

QServerEventEndpoints

condition​

Get Signature​

get condition(): () => boolean

Defined in: http/src/router/QRoute.ts:11

Returns​

() => boolean

Inherited from​

QRoute.condition

endpoints​

Get Signature​

get endpoints(): IQEndpointDefinition[]

Defined in: http/src/router/QRoute.ts:29

Returns​

IQEndpointDefinition[]

Inherited from​

QRoute.endpoints

engineMiddlewares​

Get Signature​

get engineMiddlewares(): unknown[]

Defined in: http/src/router/QRoute.ts:41

Returns​

unknown[]

Inherited from​

QRoute.engineMiddlewares

flags​

Get Signature​

get flags(): string[]

Defined in: http/src/router/QRoute.ts:17

Returns​

string[]

Inherited from​

QRoute.flags

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QRoute.logger

middlewares​

Get Signature​

get middlewares(): QEndpointMiddleware[]

Defined in: http/src/router/QRoute.ts:35

Returns​

QEndpointMiddleware[]

Inherited from​

QRoute.middlewares

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QRoute.name

Methods​

broadcast()​

broadcast(endpoint, data, messageId?): void

Defined in: http/src/router/QServerEventRoute.ts:67

Broadcast a message to all clients listening on an endpoint.

Parameters​

endpoint​

string

data​

unknown

messageId?​

string

Returns​

void

connect()​

connect<TResponse>(endpoint, client, identifier?): string

Defined in: http/src/router/QServerEventRoute.ts:97

Connect a new client to a server events endpoint.

Type Parameters​

TResponse​

TResponse extends ServerResponse<IncomingMessage>

Parameters​

endpoint​

string

Endpoint path.

client​

TResponse

HTTP response instance.

identifier?​

string

Optional client identifier.

Returns​

string

disconnect()​

protected disconnect(endpoint, clientId): void

Defined in: http/src/router/QServerEventRoute.ts:133

Remove a client from an endpoint.

Parameters​

endpoint​

string

clientId​

string

Returns​

void

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QRoute.endSpan

getClients()​

getClients(endpoint): QServerEventHandlers

Defined in: http/src/router/QServerEventRoute.ts:60

Retrieve the active clients for a given endpoint.

Parameters​

endpoint​

string

Returns​

QServerEventHandlers

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QRoute.recordSpanError

send()​

send(endpoint, clientId, data, messageId?): void

Defined in: http/src/router/QServerEventRoute.ts:78

Send a message to a specific client.

Parameters​

endpoint​

string

clientId​

string

data​

unknown

messageId?​

string

Returns​

void

setClient()​

protected setClient(endpoint, client): void

Defined in: http/src/router/QServerEventRoute.ts:123

Register a client for an endpoint.

Parameters​

endpoint​

string

client​

QServerEventClient

Returns​

void

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QRoute.setSpanAttribute

startSpan()​

protected startSpan(spanName, options?): TelemetrySpan

Defined in: core/src/QObject.ts:26

Start a telemetry span for the given operation name. Returns undefined when no telemetry provider is active.

Parameters​

spanName​

string

Name of the span.

options?​

TelemetrySpanOptions

Optional span attributes and kind.

Returns​

TelemetrySpan

Inherited from​

QRoute.startSpan

toObject()​

toObject(): Record<string, any>

Defined in: http/src/router/QRoute.ts:48

Return a plain object representation of the route.

Returns​

Record<string, any>

Inherited from​

QRoute.toObject