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/src/interaction/Subscription.ts:33

Accessors

criteria

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

id

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

isCanceledByPeer

get isCanceledByPeer(): boolean
Returns boolean
- 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
- Defined in packages/protocol/src/interaction/Subscription.ts:71

isClosed

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

session

get session(): SecureSession
Returns SecureSession
- Defined in packages/protocol/src/interaction/Subscription.ts:59

Methods

close

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

update

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

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