Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Readonly authenticated

authenticated: boolean

Readonly context

context: HostContext

Readonly downlinkCount

downlinkCount: number

Readonly downlinks

downlinks: BTree<Uri, BTree<Uri, HostDownlink, never>, never>

Readonly hostUri

hostUri: Uri

idleTimer

idleTimer: number

Readonly options

options: HostOptions

reconnectTimeout

reconnectTimeout: number

reconnectTimer

reconnectTimer: number

Readonly sendBuffer

sendBuffer: Envelope[]

Readonly session

session: Value

Readonly uriCache

uriCache: UriCache

Static Readonly IdleTimeout

IdleTimeout: number

Static Readonly MaxReconnectTimeout

MaxReconnectTimeout: number

Static Readonly SendBufferSize

SendBufferSize: number

Static Readonly UnlinkDelay

UnlinkDelay: number

Accessors

credentials

  • get credentials(): Value
  • Returns Value

idleTimeout

  • get idleTimeout(): number
  • Returns number

maxReconnectTimeout

  • get maxReconnectTimeout(): number
  • Returns number

sendBufferSize

  • get sendBufferSize(): number
  • Returns number

unlinkDelay

  • get unlinkDelay(): number
  • Returns number

Methods

authenticate

  • authenticate(credentials: AnyValue): void
  • Parameters

    Returns void

Protected checkIdle

  • checkIdle(): void
  • Returns void

Protected clearIdle

  • clearIdle(): void
  • Returns void

Protected clearReconnect

  • clearReconnect(): void
  • Returns void

close

  • close(): void
  • Returns void

closeDownlink

  • Parameters

    Returns void

closeUp

  • closeUp(): void
  • Returns void

command

  • Parameters

    Returns void

isAuthenticated

  • isAuthenticated(): boolean
  • Returns boolean

Abstract isConnected

  • isConnected(): boolean
  • Returns boolean

isIdle

  • isIdle(): boolean
  • Returns boolean

Protected onAuthRequest

  • Parameters

    Returns void

Protected onAuthedResponse

  • Parameters

    Returns void

Protected onCommandMessage

  • Parameters

    Returns void

Protected onConnect

  • onConnect(): void
  • Returns void

Protected onDeauthRequest

  • Parameters

    Returns void

Protected onDeauthedResponse

  • Parameters

    Returns void

Protected onDisconnect

  • onDisconnect(): void
  • Returns void

Protected onEnvelope

  • Parameters

    Returns void

Protected onError

  • onError(error?: unknown): void
  • Parameters

    • Optional error: unknown

    Returns void

Protected onEventMessage

  • Parameters

    Returns void

Protected onLinkRequest

  • Parameters

    Returns void

Protected onLinkedResponse

  • Parameters

    Returns void

Protected onSyncRequest

  • Parameters

    Returns void

Protected onSyncedResponse

  • Parameters

    Returns void

Protected onUnknownEnvelope

  • onUnknownEnvelope(envelope: string | Envelope): void
  • Parameters

    Returns void

Protected onUnlinkRequest

  • Parameters

    Returns void

Protected onUnlinkedResponse

  • Parameters

    Returns void

Abstract open

  • open(): void
  • Returns void

openDownlink

  • Parameters

    Returns void

Abstract push

  • Parameters

    Returns void

Protected reconnect

  • reconnect(): void
  • Returns void

resolve

  • Parameters

    Returns Uri

unlinkDownlink

  • Parameters

    Returns void

unresolve

  • Parameters

    Returns Uri

Protected watchIdle

  • watchIdle(): void
  • Returns void

Generated using TypeDoc