Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::packet::Shipper Class Reference

Prepare a packet for being sent. More...

#include <shipper.h>

Inheritance diagram for roc::packet::Shipper:
Collaboration diagram for roc::packet::Shipper:

Public Member Functions

 Shipper (IComposer &composer, IWriter &outbound_writer, const address::SocketAddr *outbound_address)
 Initialize. More...
 
const address::SocketAddroutbound_address () const
 Get destination address for outbound packets. More...
 
virtual ROC_ATTR_NODISCARD status::StatusCode write (const PacketPtr &packet)
 Write outgoing packet. More...
 

Detailed Description

Prepare a packet for being sent.

Definition at line 24 of file shipper.h.

Constructor & Destructor Documentation

◆ Shipper()

roc::packet::Shipper::Shipper ( IComposer composer,
IWriter outbound_writer,
const address::SocketAddr outbound_address 
)

Initialize.

  • composer - used to complete composing packets
  • outbound_writer - destination writer
  • outbound_address - destination address is assigned to packets, may be null

Member Function Documentation

◆ outbound_address()

const address::SocketAddr& roc::packet::Shipper::outbound_address ( ) const

Get destination address for outbound packets.

◆ write()

virtual ROC_ATTR_NODISCARD status::StatusCode roc::packet::Shipper::write ( const PacketPtr packet)
virtual

Write outgoing packet.

Implements roc::packet::IWriter.


The documentation for this class was generated from the following file: