Class SubscriptionHandler

Implements the server side of a single subscription.

Hierarchy (view full)

Constructors

constructor

Accessors

criteria id isCanceledByPeer isClosed maxInterval sendInterval session

Methods

activateSendingUpdates attributeChangeHandler attributeChangeListener close eventChangeListener flush prepareDataUpdate sendInitialReport sendUpdate unregisterAttributeListeners unregisterEventListeners update updateSubscription

Constructors

constructor

Accessors

criteria

id

  • get id(): number

  • Returns number

isCanceledByPeer

  • get isCanceledByPeer(): boolean

  • Returns boolean

  • set isCanceledByPeer(value): void

  • This flag is set on closed sessions when the close was initiated by the peer.

    Parameters

    • value: boolean

    Returns void

isClosed

  • get isClosed(): boolean

  • Returns boolean

  • set isClosed(value): void

  • Parameters

    • value: boolean

    Returns void

maxInterval

  • get maxInterval(): number

  • Returns number

sendInterval

  • get sendInterval(): number

  • Returns number

session

  • get session(): SecureSession

  • Returns SecureSession

Methods

activateSendingUpdates

  • activateSendingUpdates(): void

  • Returns void

attributeChangeHandler

  • attributeChangeHandler<T>(path, schema, version, value): MaybePromise<void>

  • Type Parameters

    • T

    Parameters

    Returns MaybePromise<void>

attributeChangeListener

  • attributeChangeListener<T>(path, schema, version, value): void

  • Type Parameters

    • T

    Parameters

    Returns void

close

  • close(graceful?): Promise<void>

  • Close the session.

    Parameters

    • Optionalgraceful: boolean

      in a server context this means flush pending updates. Not sure if applies to client subscriptions

    Returns Promise<void>

eventChangeListener

  • eventChangeListener<T>(path, schema, newEvent): void

  • Type Parameters

    • T

    Parameters

    Returns void

flush

  • flush(): Promise<void>

  • Returns Promise<void>

prepareDataUpdate

  • prepareDataUpdate(): void

  • Check if data should be sent straight away or delayed because the minimum interval is not reached. Delay real sending by 50ms in any case to mke sure to catch all updates.

    Returns void

sendInitialReport

  • sendInitialReport(messenger): Promise<void>

  • Parameters

    Returns Promise<void>

sendUpdate

  • sendUpdate(): Promise<void>

  • Determine all attributes that have changed since the last update and send them tout to the subscriber.

    Returns Promise<void>

unregisterAttributeListeners

  • unregisterAttributeListeners(list): void

  • Parameters

    • list: string[]

    Returns void

unregisterEventListeners

  • unregisterEventListeners(list): void

  • Parameters

    • list: string[]

    Returns void

update

  • update(): Promise<void>

  • Update session state. This probably is meaniningless except in a server context.

    Returns Promise<void>

updateSubscription

  • updateSubscription(): Promise<void>

  • Update the session after an endpoint structure change. The method will initialize all missing new attributes and events and will remove listeners no longer needed. Newly added attributes are then treated ad "changed values" and will be sent as subscription data update to the controller. The data of newly added events are not sent automatically.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods