Class Subscription

A single active subscription.

Hierarchy (view full)

Subscription
- ServerSubscription

Index

Constructors

Accessors

criteria id isCanceledByPeer isClosed session

Methods

Constructors

constructor

new Subscription(session, id, criteria): Subscription
Parameters
- session: SecureSession
- id: number
- criteria: SubscriptionCriteria
Returns Subscription
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:21

Accessors

criteria

get criteria(): SubscriptionCriteria
Returns SubscriptionCriteria
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:23

id

get id(): number
Returns number
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:22

isCanceledByPeer

get isCanceledByPeer(): boolean
Returns boolean
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:25
set isCanceledByPeer(value): void
This flag is set on closed sessions when the close was initiated by the peer.
Parameters
- value: boolean
Returns void
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:34

isClosed

get isClosed(): boolean
Returns boolean
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:24
set isClosed(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:35

session

get session(): SecureSession
Returns SecureSession
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:26

Methods

close

close(_graceful?): Promise<void>
Close the session.
Parameters
- Optional_graceful: boolean
  in a server context this means flush pending updates. Not sure if applies to client subscriptions
Returns Promise<void>
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:42

update

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

Returns Promise<void>
- Defined in packages/protocol/dist/esm/interaction/Subscription.d.ts:30