Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Session

Hierarchy

Index

Properties

clients

clients: ClientControl

messages

messages: Messages

metrics

metrics: Metrics

notifications

notifications: TopicNotifications

options

options: Options

remoteServers

remoteServers: RemoteServers

security

security: Security

sessionId

sessionId: SessionId

sessionTrees

sessionTrees: SessionTrees

timeseries

timeseries: TimeSeries

topicUpdate

topicUpdate: TopicUpdate

topicViews

topicViews: TopicViews

topics

topics: TopicControl

Methods

addFallbackStream

addStream

close

closeSession

  • Returns Result<CloseReason>

    a Result that completes with the close reason returned by the server. Only the Result of the first call to closeSession is guaranteed to complete. The Result will not resolve if the session is already closed.

fetchRequest

getPrincipal

  • getPrincipal(): string
  • Returns string

    the principal for this session

isClosed

  • isClosed(): boolean
  • Returns boolean

    whether the session is currently closed.

isConnected

  • isConnected(): boolean
  • Returns boolean

    whether the session is currently connected or not.

lock

  • Parameters

    Returns Result<SessionLock>

    a Promise that resolves when a response is received from the server.

    If this session has successfully acquired the session lock, or this session already owns the session lock, the Promise will resolve normally with a SessionLock result.

    If the Promise resolves with an error, this session does not own the session lock.

off

on

pingServer

  • Returns Result<PingDetails>

    a result that completes when a response is received from the server.

select

  • Parameters

    Returns Result<void>

    a result that completes when this operation succeeds

  • Parameters

    Returns Result<void>

unsubscribe

updateFeatures

  • updateFeatures(): void
  • Returns void