Class CargoMessageSet

Plaintext representation of the payload in a cargo message.

That is, the set of RAMF messages the cargo contains.

Implements

Payload

Index

Constructors

Properties

messages MAX_MESSAGE_LENGTH

Methods

serialize batchMessagesSerialized deserialize deserializeItem

Constructors

constructor

new CargoMessageSet(messages): CargoMessageSet
Parameters
- messages: readonly ArrayBuffer[]
Returns CargoMessageSet
- Defined in src/lib/messages/payloads/CargoMessageSet.ts:122

Properties

`Readonly` messages

messages: readonly ArrayBuffer[]

`Static` `Readonly` MAX_MESSAGE_LENGTH

MAX_MESSAGE_LENGTH: number = ...

Maximum number of octets for any serialized message to be included in a cargo.

This is the result of subtracting the TLVs for the SET and OCTET STRING values from the maximum size of an SDU to be encrypted.

Methods

serialize

serialize(): ArrayBuffer
Returns ArrayBuffer
Implementation of Payload.serialize
- Defined in src/lib/messages/payloads/CargoMessageSet.ts:124

`Static` batchMessagesSerialized

batchMessagesSerialized(messagesWithExpiryDate): AsyncIterable<MessageWithExpiryDate>
Parameters
- messagesWithExpiryDate: AsyncIterable<MessageWithExpiryDate>
Returns AsyncIterable<MessageWithExpiryDate>
- Defined in src/lib/messages/payloads/CargoMessageSet.ts:62

`Static` deserialize

deserialize(serialization): CargoMessageSet
Parameters
- serialization: ArrayBuffer
Returns CargoMessageSet
- Defined in src/lib/messages/payloads/CargoMessageSet.ts:37

`Static` deserializeItem

deserializeItem(itemSerialized): Promise<CargoMessageSetItem>
Deserialize a value if it's a legal item in a cargo message set.
Parameters
- itemSerialized: ArrayBuffer
  The parcel or PCA to be deserialized
Returns Promise<CargoMessageSetItem>
Throws
InvalidMessageError If itemSerialized is not a legal item in a cargo message set
- Defined in src/lib/messages/payloads/CargoMessageSet.ts:53

Generated using TypeDoc