Class MessageChunker

constructor

• new MessageChunker(options?: MessageChunkerOptions): MessageChunker

  Parameters

  • Optionaloptions: MessageChunkerOptions

  Returns MessageChunker

maxChunkCount

maxMessageSize

securityMode

Static ReadonlydefaultChunkCount

StaticdefaultMaxMessageSize

Static ReadonlyminimumMessageSizeHint

chunkSecureMessage

• chunkSecureMessage(
      msgType: string,
      params: ChunkMessageParameters,
      message: BaseUAObject,
      messageChunkCallback: MessageCallbackFunc,
  ): StatusCode

  Parameters

  • msgType: string
  • params: ChunkMessageParameters
  • message: BaseUAObject
  • messageChunkCallback: MessageCallbackFunc

  Returns StatusCode

chunkSecureMessageAsync

• chunkSecureMessageAsync(
      msgType: string,
      params: ChunkMessageParameters,
      message: BaseUAObject,
      messageChunkCallback: MessageCallbackFunc,
  ): Promise<StatusCode>

  chunkSecureMessage for an asynchronously-signing chunk manager (the OPN signature produced by a remote HSM/KMS provider): chunks are delivered to the callback as each one's signing settles, in order, and the returned promise settles after the final null callback. A provider failure rejects.

  Parameters

  • msgType: string
  • params: ChunkMessageParameters
  • message: BaseUAObject
  • messageChunkCallback: MessageCallbackFunc

  Returns Promise<StatusCode>

dispose

• dispose(): void

  Returns void

maxBodySize

• maxBodySize(msgType: string, params: ChunkMessageParameters): number

  The largest message body prepareChunk accepts with these parameters, or 0 when neither limit applies: the negotiated maxMessageSize, and maxChunkCount times what one chunk carries under the channel's security. The second is the tighter one whenever a peer derives its chunk count as maxMessageSize / bufferSize, as the CTT does, because every chunk also spends bytes on headers.

  Parameters

  • msgType: string
  • params: ChunkMessageParameters

  Returns number

prepareChunk

• prepareChunk(
      msgType: string,
      params: ChunkMessageParameters,
      messageLength: number,
  ): {
      chunkManager: SecureMessageChunkManager | null;
      statusCode: StatusCode;
  }

  Parameters

  • msgType: string
  • params: ChunkMessageParameters
  • messageLength: number

  Returns { chunkManager: SecureMessageChunkManager | null; statusCode: StatusCode }