Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::netio::UdpSenderPort Class Reference

UDP sender. More...

#include <udp_sender_port.h>

Inheritance diagram for roc::netio::UdpSenderPort:
Collaboration diagram for roc::netio::UdpSenderPort:

Public Member Functions

 UdpSenderPort (const UdpSenderConfig &config, uv_loop_t &event_loop, core::IArena &arena)
 Initialize. More...
 
 ~UdpSenderPort ()
 Destroy. More...
 
const address::SocketAddrbind_address () const
 Get bind address. More...
 
virtual bool open ()
 Open sender. More...
 
virtual AsyncOperationStatus async_close (ICloseHandler &handler, void *handler_arg)
 Asynchronously close sender. More...
 
virtual ROC_ATTR_NODISCARD status::StatusCode write (const packet::PacketPtr &)
 Write packet. More...
 
- Public Member Functions inherited from roc::netio::BasicPort
 BasicPort (core::IArena &)
 Initialize. More...
 
virtual ~BasicPort ()
 Destroy. More...
 
const char * descriptor () const
 Get a human-readable port description. More...
 
- Public Member Functions inherited from roc::core::RefCounted< BasicPort, core::ArenaAllocation >
 RefCounted ()
 Initialize. More...
 
 RefCounted (const core::ArenaAllocation &policy)
 Initialize. More...
 
int getref () const
 Get reference counter. More...
 
void incref () const
 Increment reference counter. More...
 
void decref () const
 Decrement reference counter. More...
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data. More...
 

Protected Member Functions

virtual void format_descriptor (core::StringBuilder &b)
 Format descriptor. More...
 
- Protected Member Functions inherited from roc::netio::BasicPort
void update_descriptor ()
 Format descriptor and store into internal buffer. More...
 
- Protected Member Functions inherited from roc::core::ArenaAllocation
IArenaarena () const
 Get arena. More...
 
 ArenaAllocation (IArena &arena)
 Initialize. More...
 
template<class T >
void destroy (T &object)
 Destroy object and return memory to arena. More...
 

Detailed Description

UDP sender.

Definition at line 58 of file udp_sender_port.h.

Constructor & Destructor Documentation

◆ UdpSenderPort()

roc::netio::UdpSenderPort::UdpSenderPort ( const UdpSenderConfig config,
uv_loop_t &  event_loop,
core::IArena arena 
)

Initialize.

◆ ~UdpSenderPort()

roc::netio::UdpSenderPort::~UdpSenderPort ( )

Destroy.

Member Function Documentation

◆ async_close()

virtual AsyncOperationStatus roc::netio::UdpSenderPort::async_close ( ICloseHandler handler,
void *  handler_arg 
)
virtual

Asynchronously close sender.

Implements roc::netio::BasicPort.

◆ bind_address()

const address::SocketAddr& roc::netio::UdpSenderPort::bind_address ( ) const

Get bind address.

◆ format_descriptor()

virtual void roc::netio::UdpSenderPort::format_descriptor ( core::StringBuilder b)
protectedvirtual

Format descriptor.

Implements roc::netio::BasicPort.

◆ open()

virtual bool roc::netio::UdpSenderPort::open ( )
virtual

Open sender.

Implements roc::netio::BasicPort.

◆ write()

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

Write packet.

Remarks
May be called from any thread.

Implements roc::packet::IWriter.


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