async_comm::UDP Class Reference

Asynchronous communication class for a UDP socket. More...

#include <udp.h>

Inheritance diagram for async_comm::UDP:

Public Member Functions
	UDP (std::string bind_host=DEFAULT_BIND_HOST, uint16_t bind_port=DEFAULT_BIND_PORT, std::string remote_host=DEFAULT_REMOTE_HOST, uint16_t remote_port=DEFAULT_REMOTE_PORT)
	Bind a UDP socket. More...
	~UDP ()
Public Member Functions inherited from async_comm::Comm
void	close ()
	Closes the port. More...
	Comm ()
bool	init ()
	Initializes and opens the port. More...
void	register_receive_callback (std::function< void(const uint8_t *, size_t)> fun)
	Register a callback function for when bytes are received on the port. More...
void	send_byte (uint8_t data)
	Send a single byte over the port. More...
void	send_bytes (const uint8_t *src, size_t len)
	Send bytes from a buffer over the port. More...
virtual	~Comm ()

Private Member Functions
void	do_async_read (const boost::asio::mutable_buffers_1 &buffer, boost::function< void(const boost::system::error_code &, size_t)> handler) override
void	do_async_write (const boost::asio::const_buffers_1 &buffer, boost::function< void(const boost::system::error_code &, size_t)> handler) override
void	do_close () override
bool	do_init () override
bool	is_open () override

Private Attributes
boost::asio::ip::udp::endpoint	bind_endpoint_
std::string	bind_host_
uint16_t	bind_port_
boost::asio::ip::udp::endpoint	remote_endpoint_
std::string	remote_host_
uint16_t	remote_port_
boost::asio::ip::udp::socket	socket_

Static Private Attributes
static constexpr auto	DEFAULT_BIND_HOST = "localhost"
static constexpr uint16_t	DEFAULT_BIND_PORT = 16140
static constexpr auto	DEFAULT_REMOTE_HOST = "localhost"
static constexpr uint16_t	DEFAULT_REMOTE_PORT = 16145

Additional Inherited Members
Protected Attributes inherited from async_comm::Comm
boost::asio::io_service	io_service_
Static Protected Attributes inherited from async_comm::Comm
static constexpr size_t	READ_BUFFER_SIZE = 1024
static constexpr size_t	WRITE_BUFFER_SIZE = 1024

Detailed Description

Asynchronous communication class for a UDP socket.

Definition at line 55 of file udp.h.

Constructor & Destructor Documentation

async_comm::UDP::UDP	(	std::string	bind_host = DEFAULT_BIND_HOST,
		uint16_t	bind_port = DEFAULT_BIND_PORT,
		std::string	remote_host = DEFAULT_REMOTE_HOST,
		uint16_t	remote_port = DEFAULT_REMOTE_PORT
	)

Bind a UDP socket.

Parameters

bind_host	The bind host where this application is listening (usually "localhost")
bind_port	The bind port where this application is listening
remote_host	The remote host to communicate with
remote_port	The port on the remote host

Definition at line 48 of file udp.cpp.

async_comm::UDP::~UDP

(

)

Definition at line 58 of file udp.cpp.

Member Function Documentation

void async_comm::UDP::do_async_read ( const boost::asio::mutable_buffers_1 &  buffer, boost::function< void(const boost::system::error_code &, size_t)>  handler  )

overrideprivatevirtual

Implements async_comm::Comm.

Definition at line 101 of file udp.cpp.

void async_comm::UDP::do_async_write ( const boost::asio::const_buffers_1 &  buffer, boost::function< void(const boost::system::error_code &, size_t)>  handler  )

overrideprivatevirtual

Implements async_comm::Comm.

Definition at line 107 of file udp.cpp.

void async_comm::UDP::do_close ( )

overrideprivatevirtual

Implements async_comm::Comm.

Definition at line 96 of file udp.cpp.

bool async_comm::UDP::do_init ( )

overrideprivatevirtual

Implements async_comm::Comm.

Definition at line 68 of file udp.cpp.

bool async_comm::UDP::is_open ( )

overrideprivatevirtual

Implements async_comm::Comm.

Definition at line 63 of file udp.cpp.

Member Data Documentation

boost::asio::ip::udp::endpoint async_comm::UDP::bind_endpoint_

private

Definition at line 90 of file udp.h.

std::string async_comm::UDP::bind_host_

private

Definition at line 83 of file udp.h.

uint16_t async_comm::UDP::bind_port_

private

Definition at line 84 of file udp.h.

constexpr auto async_comm::UDP::DEFAULT_BIND_HOST = "localhost"

staticprivate

Definition at line 70 of file udp.h.

constexpr uint16_t async_comm::UDP::DEFAULT_BIND_PORT = 16140

staticprivate

Definition at line 71 of file udp.h.

constexpr auto async_comm::UDP::DEFAULT_REMOTE_HOST = "localhost"

staticprivate

Definition at line 72 of file udp.h.

constexpr uint16_t async_comm::UDP::DEFAULT_REMOTE_PORT = 16145

staticprivate

Definition at line 73 of file udp.h.

boost::asio::ip::udp::endpoint async_comm::UDP::remote_endpoint_

private

Definition at line 91 of file udp.h.

std::string async_comm::UDP::remote_host_

private

Definition at line 86 of file udp.h.

uint16_t async_comm::UDP::remote_port_

private

Definition at line 87 of file udp.h.

boost::asio::ip::udp::socket async_comm::UDP::socket_

private

Definition at line 89 of file udp.h.

---

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

• udp.h
• udp.cpp