Cell API
    Preparing search index...

    Class ChannelMessageReader

    Hierarchy

    • AbstractMessageReader
      • ChannelMessageReader
    Index
    constructor
    callback channel events state
    onClose onError onPartialMessage
    dispose fireClose fireError firePartialMessage listen readMessage
    callback: DataCallback | undefined
    channel: Channel
    events: { error?: any; message?: any }[] = []
    state: "initial" | "listening" | "closed" = 'initial'
    • get onClose(): Event<void>

      An event raised when the end of the underlying transport has been reached.

      Returns Event<void>

    • get onError(): Event<Error>

      Raised whenever an error occurs while reading a message.

      Returns Event<Error>

    • get onPartialMessage(): Event<PartialMessageInfo>

      An event that may be raised to inform the owner that only part of a message has been received. A MessageReader implementation may choose to raise this event after a timeout elapses while waiting for more of a partially received message to be received.

      Returns Event<PartialMessageInfo>

    • Releases resources incurred from reading or raising events. Does NOT close the underlying transport, if any.

      Returns void

    • Returns void

    • Parameters

      • info: PartialMessageInfo

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods