roc::netio::UdpPort Class Reference

UDP sender/receiver port. More...

#include <roc_netio/target_libuv/roc_netio/udp_port.h>

Inheritance diagram for roc::netio::UdpPort:

Public Member Functions
	UdpPort (const UdpConfig &config, uv_loop_t &event_loop, packet::PacketFactory &packet_factory, core::IArena &arena)
	Initialize.
virtual	~UdpPort ()
	Destroy.
const address::SocketAddr &	bind_address () const
	Get bind address.
virtual bool	open ()
	Open receiver.
virtual AsyncOperationStatus	async_close (ICloseHandler &handler, void *handler_arg)
	Asynchronously close receiver.
packet::IWriter *	start_send ()
	Start receiving packets.
bool	start_recv (packet::IWriter &inbound_writer)
	Start receiving packets.
Public Member Functions inherited from roc::netio::BasicPort
	BasicPort (core::IArena &)
	Initialize.
virtual	~BasicPort ()
	Destroy.
const char *	descriptor () const
	Get a human-readable port description.
Public Member Functions inherited from roc::core::RefCounted< BasicPort, core::ArenaAllocation >
	RefCounted ()
	Initialize.
	RefCounted (const core::ArenaAllocation &policy)
	Initialize.
int	getref () const
	Get reference counter.
void	incref () const
	Increment reference counter.
void	decref () const
	Decrement reference counter.
Public Member Functions inherited from roc::core::ListNode< Tag >
ListData *	list_data () const
	Get pointer to internal data.

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

Additional Inherited Members
Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNode *	list_node (ListData *data)
	Get pointer to parent node from pointer to internal data.

Detailed Description

UDP sender/receiver port.

Definition at line 70 of file udp_port.h.

Constructor & Destructor Documentation

UdpPort()

roc::netio::UdpPort::UdpPort	(	const UdpConfig &	config,
		uv_loop_t &	event_loop,
		packet::PacketFactory &	packet_factory,
		core::IArena &	arena
	)

Initialize.

~UdpPort()

virtual roc::netio::UdpPort::~UdpPort ( )

virtual

Destroy.

Member Function Documentation

async_close()

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

virtual

Asynchronously close receiver.

Implements roc::netio::BasicPort.

bind_address()

const address::SocketAddr & roc::netio::UdpPort::bind_address

(

)

const

Get bind address.

format_descriptor()

virtual void roc::netio::UdpPort::format_descriptor ( core::StringBuilder &  b )

protectedvirtual

Format descriptor.

Implements roc::netio::BasicPort.

open()

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

virtual

Open receiver.

Implements roc::netio::BasicPort.

start_recv()

bool roc::netio::UdpPort::start_recv

(

packet::IWriter &

inbound_writer

)

Start receiving packets.

Remarks

Received packets will be written to inbound_writer. Writer will be invoked from network thread.

start_send()

packet::IWriter * roc::netio::UdpPort::start_send

(

)

Start receiving packets.

Remarks

Packets written to returned writer will be enqueued for sending. Writer can be used from any thread.

---

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

• roc_netio/target_libuv/roc_netio/udp_port.h