Class BinaryMessagePipe

Protected cachedMessageData

Protected onMessageEmitter

Protected Readonly underlyingPipe

Protected messageStartByteLength

• get messageStartByteLength(): number

• Returns number

Protected dataHandler

• dataHandler(chunk): void

• Parameters

  • chunk: Uint8Array

  Returns void

Protected emitCachedMessage

• emitCachedMessage(): void

• Returns void

Protected encodeMessageStart

• encodeMessageStart(message): Uint8Array

• Encodes the start of a new message into a Uint8Array. The message start consists of a identifier string and the length of the following message.

  Parameters

  • message: Uint8Array

  Returns Uint8Array

  the buffer contains the encoded message start

Protected handleChunk

• handleChunk(chunk): void

• Parameters

  • chunk: Uint8Array

  Returns void

Protected handleMessageContentChunk

• handleMessageContentChunk(chunk): void

• Parameters

  • chunk: Uint8Array

  Returns void

Protected handleNewMessage

• handleNewMessage(chunk): void

• Parameters

  • chunk: Uint8Array

  Returns void

Protected readMessageStart

• readMessageStart(chunk): number

• Reads the start of a new message from a stream chunk (or cached message) received from the underlying pipe. The message start is expected to consist of an identifier string and the length of the message.

  Parameters

  • chunk: Uint8Array

    The stream chunk.

  Returns number

  The length of the message content to read.

  Throws

  An error if the message start can not be read successfully.