Class Frame

constructor

• new Frame(..._arguments_: unknown[]): Frame

  Creates a new data type.

  Parameters

  • ..._arguments_: unknown[]

  Returns Frame

orderChannel

orderIndex

payload

reliability

reliableIndex

sequenceIndex

splitId

splitIndex

splitSize

getByteLength

• getByteLength(): number

  Gets the byte length of the frame.

  Returns number

  The byte length of the frame.

isOrdered

• isOrdered(): boolean

  Checks if the frame is ordered.

  Returns boolean

  True if the frame is ordered; otherwise, false.

isOrderExclusive

• isOrderExclusive(): boolean

  Checks if the frame is order exclusive.

  Returns boolean

  True if the frame is order exclusive; otherwise, false.

isReliable

• isReliable(): boolean

  Checks if the frame is reliable.

  Returns boolean

  True if the frame is reliable; otherwise, false.

isSequenced

• isSequenced(): boolean

  Checks if the frame is sequenced.

  Returns boolean

  True if the frame is sequenced; otherwise, false.

isSplit

• isSplit(): boolean

  Checks if the frame is split.

  Returns boolean

  True if the frame is split; otherwise, false.

Staticread

• read(stream: BinaryStream): Frame[]

  Reads the Frame data type from a binary stream.

  Parameters

  • stream: BinaryStream

    The binary stream to read from.

  Returns Frame[]

  The Frame data type.

Staticwrite

• write(stream: BinaryStream, value: Frame[]): void

  Writes the Frame data type to a binary stream.

  Parameters

  • stream: BinaryStream

    The binary stream to write to.
  • value: Frame[]

  Returns void