Class WebsocketOutbound

This object is used to configure an outbound. Outbounds are used to send data to clients and support features like authentication checks and subscription management.

Hierarchy

AuthableDecorableFunction
- WebsocketOutbound

Constructors

constructor

new WebsocketOutbound(method, objConfig, lazyLoading?, resendAfterAuthenticationChange?): WebsocketOutbound
Creates a new outbound configuration.
Parameters
- method: string
  
  The method represents a unique identifier for the outbound. Data sent is labeled using the method.
- objConfig: {
  propertyKey: string;
  target: any;
  }
  
  The configuration object containing the method functionality.
  - propertyKey: string
    
    The name of the function within the class.
  - target: any
    
    The prototype of the class containing the source code of this outbound. (e.g., MyClass.prototype)
- Optional lazyLoading: boolean
  
  When enabled, data is not sent initially to all clients. They can request it if needed.
- Optional resendAfterAuthenticationChange: boolean
  
  When enabled, data is updated once any route with modifiesAuthentication=true is called by this connection. This can be used to automatically send the user data to the client once the client is signed in.
Returns WebsocketOutbound
Overrides AuthableDecorableFunction.constructor
- Defined in src/websocket/server/routing/outbound.ts:42

Properties

`Private` _lazyLoading

_lazyLoading: boolean = false

`Protected` authenticator

authenticator: WebsocketAuthenticator = null

`Private` decoratorConfigReference

decoratorConfigReference: WebsocketOutboundDecoratorConfig

`Protected` isOutbound

isOutbound: boolean = false

method

method: string

The method represents a unique identifier for the outbound. Data sent is labeled using the method.

`Protected` objConfig

objConfig: {
propertyKey: string;
target: any;
}

The configuration object for the object method.

Type declaration

propertyKey: string
target: any

partialUpdates

partialUpdates: boolean = false

When enabled updated data resent using subscriptions does only send differential data (inserted, updated, deleted).

`Optional` resendAfterAuthenticationChange

resendAfterAuthenticationChange?: boolean

When enabled, data is updated once any route with modifiesAuthentication=true is called by this connection. This can be used to automatically send the user data to the client once the client is signed in.

`Private` subscribedConnections

subscribedConnections: Map<number, WebsocketConnection[]> = ...

`Private` subscribesChanges

subscribesChanges: boolean = false

`Private` subscribesFilteredChanges

subscribesFilteredChanges: MessageFilter[] = []

supportsCache

supportsCache: boolean = false

When enabled, data is not sent initially when the client supports caching. If the client supports caching, data is sent once the client has transmitted the cache key.

Accessors

Func

get Func(): ((...data) => any)
Returns the decorated function with added authentication checks.

Returns ((...data) => any)
- The decorated function.
- - (...data): any
  - Returns the decorated function with added authentication checks.
    Parameters
    - Rest ...data: any[]
    Returns any
    - The decorated function.
Inherited from AuthableDecorableFunction.Func
- Defined in src/decorator-config/function.ts:82

hasAuthenticator

get hasAuthenticator(): boolean
Checks if the decorated function has an authenticator.

Returns boolean
- Indicates whether the decorated function has an authenticator.
Inherited from AuthableDecorableFunction.hasAuthenticator
- Defined in src/decorator-config/function.ts:115

lazyLoading

get lazyLoading(): boolean
When enabled, data is not sent initially to all clients. They can request it if needed.

Returns boolean
- Defined in src/websocket/server/routing/outbound.ts:86
set lazyLoading(lazyLoading): void
When enabled, data is not sent initially to all clients. They can request it if needed.
Parameters
- lazyLoading: boolean
Returns void
- Defined in src/websocket/server/routing/outbound.ts:58

subscriptionEnabled

get subscriptionEnabled(): boolean
Determines if subscriptions are enabled for this outbound.

Returns boolean
- Defined in src/websocket/server/routing/outbound.ts:542

Methods

`Private` addSubscriptionForKey

addSubscriptionForKey(key, conn): void
Parameters
- key: number
- conn: WebsocketConnection
Returns void
- Defined in src/websocket/server/routing/outbound.ts:133

authenticate

authenticate(conn): Promise<boolean>
Checks whether the connection has sufficient permission to receive this outbound.
Parameters
- conn: WebsocketConnection
Returns Promise<boolean>
- Defined in src/websocket/server/routing/outbound.ts:570

`Protected` authenticateOrThrow

authenticateOrThrow(conn, requestData?): Promise<void>
Parameters
- conn: WebsocketConnection
- Optional requestData: any
Returns Promise<void>
Inherited from AuthableDecorableFunction.authenticateOrThrow
- Defined in src/decorator-config/function.ts:101

bindDecoratorConfig

bindDecoratorConfig(reference): WebsocketOutbound
Binds the decorator configuration reference to the WebSocket outbound.
Parameters
- reference: WebsocketOutboundDecoratorConfig
  
  The decorator configuration reference.
Returns WebsocketOutbound
- The WebSocket outbound instance.
- Defined in src/websocket/server/routing/outbound.ts:562

clearSubscriptions

clearSubscriptions(): void
Removes all subscriptions for this outbound

Returns void
- Defined in src/websocket/server/routing/outbound.ts:157

connectionSubscribesForChanges

connectionSubscribesForChanges(conn): boolean
Checks if the provided connection is subscribed to changes for this outbound.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to check.
Returns boolean
True if the connection is subscribed, otherwise false.
- Defined in src/websocket/server/routing/outbound.ts:475

getSubscribingConnections

getSubscribingConnections(key?): WebsocketConnection[]
Gets the WebSocket connections that are subscribed to changes for this outbound.
Parameters
- Optional key: number
  
  Optional key used to filter the connections. If provided, only connections with the specified key will be returned.
Returns WebsocketConnection[]
An array of WebSocketConnection instances that are subscribed to changes for this outbound.
- Defined in src/websocket/server/routing/outbound.ts:150

`Private` handleError

handleError(e, conn, sendDeleteOnAuthError?): void
Parameters
- e: any
- conn: WebsocketConnection
- sendDeleteOnAuthError: boolean = false
Returns void
- Defined in src/websocket/server/routing/outbound.ts:344

loadDecoratorConfig

loadDecoratorConfig(): void
Loads the decorator configuration from the bound reference.

Returns void
- Defined in src/websocket/server/routing/outbound.ts:577

resetSubscriptions

resetSubscriptions(): void
Returns void
- Defined in src/websocket/server/routing/outbound.ts:605

sendData

sendData(conn, id?, groupId?, sendDeleteOnAuthError?): Promise<void>
Sends the outbound data to the provided connection.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to send the data to.
- Optional id: number
- Optional groupId: number
- Optional sendDeleteOnAuthError: boolean
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:221

`Protected` sendError

sendError(conn, message): void
Handles an error when it occurs during outbound function execution.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to send the error message to.
- message: string
  
  The error message to send.
Returns void
Overrides AuthableDecorableFunction.sendError
- Defined in src/websocket/server/routing/outbound.ts:551

sendTo

sendTo(conn, requestConfig?, sendDeleteOnAuthError?): Promise<void>
Sends the outbound data to the provided connection. If caching is enabled, the caching hash is checked in advance.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to send the data to.
- Optional requestConfig: {
      count: number;
      groupId: number;
      id: number;
  }
  - count: number
  - groupId: number
  - id: number
- Optional sendDeleteOnAuthError: boolean
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:166

sendToIfContentChanged

sendToIfContentChanged(conn, specificHash): Promise<void>
Checks whether the data has been changed and sends the updated data to the client.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to send the data to.
- specificHash: number
  
  The specific hash value
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:393

sendToIfSubscribed

sendToIfSubscribed(conn, sendDeleteOnAuthError?): Promise<void>
Sends the outbound data to the provided connection if it is subscribed to changes.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to send the data to.
- Optional sendDeleteOnAuthError: boolean
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:370

sendUpdatedData

sendUpdatedData(key?): Promise<void>
Sends updated data to all subscribed connections for the specified key or for all changes.
Parameters
- Optional key: number
  
  Optional key for filtering the connections to update.
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:490

setAuthenticator

setAuthenticator(authenticator): void
Sets the authenticator for the decorated function.
Parameters
- authenticator: WebsocketAuthenticator
  
  The websocket authenticator.
Returns void
Inherited from AuthableDecorableFunction.setAuthenticator
- Defined in src/decorator-config/function.ts:74

subscribeChanges

subscribeChanges(filter?): void
Enables subscribing to changes for this outbound.
Parameters
- Optional filter: MessageFilter
  
  Optional filter for subscribing to filtered changes.
Returns void
- Defined in src/websocket/server/routing/outbound.ts:108

subscribeForConnection

subscribeForConnection(conn, response): Promise<void>
Subscribes the provided connection to this outbound's changes.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to subscribe.
- response: any
  
  The response object associated with the subscription.
Returns Promise<void>
- Defined in src/websocket/server/routing/outbound.ts:121

unsubscribeConnection

unsubscribeConnection(conn): void
Unsubscribes the provided connection from all subscriptions.
Parameters
- conn: WebsocketConnection
  
  The WebSocket connection to unsubscribe.
Returns void
- Defined in src/websocket/server/routing/outbound.ts:529

Class WebsocketOutbound

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

method: string

objConfig: { propertyKey: string; target: any; }

propertyKey: string

target: any

Optional lazyLoading: boolean

Optional resendAfterAuthenticationChange: boolean

Returns WebsocketOutbound

Properties

Private _lazyLoading

Protected authenticator

Private decoratorConfigReference

Protected isOutbound

method

Protected objConfig

Type declaration

propertyKey: string

target: any

partialUpdates

Optional resendAfterAuthenticationChange

Private subscribedConnections

Private subscribesChanges

Private subscribesFilteredChanges

supportsCache

Accessors

Func

Returns ((...data) => any)

Parameters

Rest ...data: any[]

Returns any

hasAuthenticator

Returns boolean

lazyLoading

Returns boolean

Parameters

lazyLoading: boolean

Returns void

subscriptionEnabled

Returns boolean

Methods

Private addSubscriptionForKey

Parameters

key: number

conn: WebsocketConnection

Returns void

authenticate

Parameters

conn: WebsocketConnection

Returns Promise<boolean>

Protected authenticateOrThrow

Parameters

conn: WebsocketConnection

Optional requestData: any

Returns Promise<void>

bindDecoratorConfig

Parameters

reference: WebsocketOutboundDecoratorConfig

Returns WebsocketOutbound

clearSubscriptions

Returns void

connectionSubscribesForChanges

Parameters

conn: WebsocketConnection

Returns boolean

getSubscribingConnections

Parameters

Optional key: number

Returns WebsocketConnection[]

Private handleError

Parameters

e: any

objConfig: {
propertyKey: string;
target: any;
}

`Optional` lazyLoading: boolean

`Optional` resendAfterAuthenticationChange: boolean

`Private` _lazyLoading

`Protected` authenticator

`Private` decoratorConfigReference

`Protected` isOutbound

`Protected` objConfig

`Optional` resendAfterAuthenticationChange

`Private` subscribedConnections

`Private` subscribesChanges

`Private` subscribesFilteredChanges

`Rest` ...data: any[]

`Private` addSubscriptionForKey

`Protected` authenticateOrThrow

`Optional` requestData: any

`Optional` key: number

`Private` handleError

`Optional` id: number

`Optional` groupId: number

`Optional` sendDeleteOnAuthError: boolean

`Protected` sendError

`Optional` requestConfig: {
count: number;
groupId: number;
id: number;
}

`Optional` sendDeleteOnAuthError: boolean

`Optional` sendDeleteOnAuthError: boolean

`Optional` key: number

`Optional` filter: MessageFilter