Class ServerSubscription

Implements the server side of a single subscription.

Hierarchy (view full)

Subscription
- ServerSubscription

Constructors

constructor

new ServerSubscription(options): ServerSubscription
Parameters
- options: {
      context: ServerSubscriptionContext;
      criteria: SubscriptionCriteria;
      id: number;
      maxIntervalCeiling: number;
      minIntervalFloor: number;
      subscriptionOptions: ServerSubscriptionConfig;
  }
  - context: ServerSubscriptionContext
  - criteria: SubscriptionCriteria
  - id: number
  - maxIntervalCeiling: number
  - minIntervalFloor: number
  - subscriptionOptions: ServerSubscriptionConfig
Returns ServerSubscription
Overrides Subscription.constructor
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:181

Accessors

criteria

get criteria(): SubscriptionCriteria
Returns SubscriptionCriteria
Inherited from Subscription.criteria
- Defined in packages/protocol/src/interaction/Subscription.ts:47

id

get id(): number
Returns number
Inherited from Subscription.id
- Defined in packages/protocol/src/interaction/Subscription.ts:43

isCanceledByPeer

get isCanceledByPeer(): boolean
Returns boolean
Inherited from Subscription.isCanceledByPeer
- Defined in packages/protocol/src/interaction/Subscription.ts:55
set isCanceledByPeer(value): void
This flag is set on closed sessions when the close was initiated by the peer.
Parameters
- value: boolean
Returns void
Inherited from Subscription.isCanceledByPeer
- Defined in packages/protocol/src/interaction/Subscription.ts:71

isClosed

get isClosed(): boolean
Returns boolean
Inherited from Subscription.isClosed
- Defined in packages/protocol/src/interaction/Subscription.ts:51
set isClosed(value): void
Parameters
- value: boolean
Returns void
Inherited from Subscription.isClosed
- Defined in packages/protocol/src/interaction/Subscription.ts:75

Methods

activateSendingUpdates

activateSendingUpdates(): void
Returns void
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:481

attributeChangeHandler

attributeChangeHandler<T>(path, schema, version, value): MaybePromise<void>
Type Parameters
- T
Parameters
- path: AttributePath
- schema: TlvSchema<T>
- version: number
- value: T
Returns MaybePromise<void>
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:757

attributeChangeListener

attributeChangeListener<T>(path, schema, version, value): void
Type Parameters
- T
Parameters
- path: AttributePath
- schema: TlvSchema<T>
- version: number
- value: T
Returns void
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:747

close

close(graceful?): Promise<void>
Close the session.
Parameters
- graceful: boolean = false
  in a server context this means flush pending updates. Not sure if applies to client subscriptions
Returns Promise<void>
Overrides Subscription.close
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:814

eventChangeListener

eventChangeListener<T>(path, schema, newEvent): void
Type Parameters
- T
Parameters
- path: EventPath
- schema: TlvSchema<T>
- newEvent: EventStorageData<T>
Returns void
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:786

flush

flush(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:804

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
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:499

sendInitialReport

sendInitialReport(messenger): Promise<void>
Parameters
- messenger: InteractionServerMessenger
Returns Promise<void>
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:613

sendUpdate

sendUpdate(): Promise<void>
Determine all attributes that have changed since the last update and send them tout to the subscriber.

Returns Promise<void>
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:531

unregisterAttributeListeners

unregisterAttributeListeners(list): void
Parameters
- list: string[]
Returns void
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:323

unregisterEventListeners

unregisterEventListeners(list): void
Parameters
- list: string[]
Returns void
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:402

update

update(): Promise<void>
Update session state. This probably is meaniningless except in a server context.

Returns Promise<void>
Inherited from Subscription.update
- Defined in packages/protocol/src/interaction/Subscription.ts:66

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>
- Defined in packages/protocol/src/interaction/ServerSubscription.ts:421

Class ServerSubscription

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

context: ServerSubscriptionContext

criteria: SubscriptionCriteria

id: number

maxIntervalCeiling: number

minIntervalFloor: number

subscriptionOptions: ServerSubscriptionConfig

Returns ServerSubscription

Accessors

criteria

Returns SubscriptionCriteria

id

Returns number

isCanceledByPeer

Returns boolean

Parameters

Returns void

isClosed

Returns boolean

Parameters

Returns void

maxInterval

Returns number

sendInterval

Returns number

session

Returns SecureSession

Methods

activateSendingUpdates

Returns void

attributeChangeHandler

Type Parameters

Parameters

Returns MaybePromise<void>

attributeChangeListener

Type Parameters

Parameters

Returns void

close

Parameters

Returns Promise<void>

eventChangeListener

Type Parameters

Parameters

Returns void

flush

Returns Promise<void>

prepareDataUpdate

Returns void

sendInitialReport

Parameters

Returns Promise<void>

sendUpdate

Returns Promise<void>

unregisterAttributeListeners

Parameters

Returns void

unregisterEventListeners

Parameters

Returns void

update

Returns Promise<void>

updateSubscription

Returns Promise<void>

Settings

On This Page