Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Channel

name

Channel

Hierarchy

  • Channel

Index

Methods

closeChannel

  • closeChannel(): void
  • Closes the channel to the Liberator. This will result in a corresponding call to onChannelClose declared in ChannelListener on the DataSource. The delay before onChannelClose is called is defined by the Liberator configuration item, active-discard-timeout.

    Returns void

getSubject

  • getSubject(): string
  • Returns the subject name to which the channel relates.

    Returns string

    The subject of this channel.

send

  • Sends fields to the channel subject

    Parameters

    • fields: {}

      the fields to send

      • [key: string]: string
    • commandListener: CommandListener

      optional callback for command completion (can set to null).

    Returns void

sendWithFieldList

  • Sends fields to the channel subject allowing for a field to be repeatedly specified in the same message.

    Parameters

    • fields: STuple[]

      the fields to send. Note: for Javascript this should be a JSON object of the form [{field1:"value1"}, {field2:"value2"}, {field3:"value3"}]

    • commandListener: CommandListener

      optional callback for command completion (can set to null).

    Returns void

Generated using TypeDoc