Class Channel<Payload, PeerAddress>Abstract

constructor

• new Channel<Payload, PeerAddress>(node, peer, deliveryAuthPath, keyStores, cryptoOptions?): Channel<Payload, PeerAddress>

• Type Parameters

  • Payload extends Payload

  • PeerAddress extends PeerInternetAddress

  Parameters

  • node: Node<Payload, PeerAddress>

  • peer: Peer<PeerAddress>

  • deliveryAuthPath: CertificationPath

  • keyStores: KeyStoreSet

  • cryptoOptions: Partial<NodeCryptoOptions> = {}

  Returns Channel<Payload, PeerAddress>

cryptoOptions

Readonly deliveryAuthPath

Readonly keyStores

Readonly node

Readonly peer

getOutboundRAMFRecipient

• getOutboundRAMFRecipient(): Recipient

• Returns Recipient

makeMessage

• makeMessage(payload, messageConstructor, options?): Promise<ArrayBuffer>

• Generate and serialise a message with the given payload.

  Parameters

  • payload: ArrayBuffer | Payload

    The payload to encrypt and encapsulate

  • messageConstructor: RAMFMessageConstructor<Payload>

    The message class constructor

  • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

  Returns Promise<ArrayBuffer>