travesim::udp::Sender Class Reference

Sender class using UDP. More...

#include "sender.hpp"

Inheritance diagram for travesim::udp::Sender:

Collaboration diagram for travesim::udp::Sender:

Public Member Functions
	Sender (const std::string receiver_address, const short receiver_port)
	Construct a new Sender object. More...
virtual	~Sender ()
	Destroy the Sender object. More...
size_t	send (const char *buffer, const size_t buffer_size)
	Send data using UDP. More...
void	set_receiver_endpoint (const std::string receiver_address, const short receiver_port)
	Set the receiver endpoint object. More...

Protected Attributes
boost::asio::ip::udp::socket *	socket
boost::asio::ip::udp::endpoint	endpoint

Private Attributes
boost::asio::io_context	io_context

Detailed Description

Sender class using UDP.

Definition at line 25 of file sender.hpp.

Constructor & Destructor Documentation

Sender()

travesim::udp::Sender::Sender	(	const std::string	receiver_address,
		const short	receiver_port
	)

Construct a new Sender object.

Parameters

receiver_address	Address where to send data
receiver_port	Port where to send data

Definition at line 33 of file sender.cpp.

                                                              {
    this->set_receiver_endpoint(receiver_address, receiver_port);

    this->socket = new boost::asio::ip::udp::socket(this->io_context);
    this->socket->open(this->endpoint.protocol());
};

References endpoint, io_context, set_receiver_endpoint(), and socket.

Here is the call graph for this function:

~Sender()

travesim::udp::Sender::~Sender ( )

virtual

Destroy the Sender object.

Definition at line 40 of file sender.cpp.

                {
    this->socket->close();

    delete this->socket;
};

References socket.

Member Function Documentation

send()

size_t travesim::udp::Sender::send	(	const char *	buffer,
		const size_t	buffer_size
	)

Send data using UDP.

Parameters

buffer	Buffer to be sent
buffer_size	Size of the buffer to be sent

Returns

size_t Number of bytes sent

Todo:

Message logging?

Definition at line 46 of file sender.cpp.

                                                                {
    size_t bytes_sent;
    boost::system::error_code ec;

    bytes_sent = this->socket->send_to(boost::asio::buffer(buffer, buffer_size), this->endpoint, NO_FLAGS, ec);

    switch (ec.value()) {
        case boost::system::errc::success: {
            /**
             * @todo Message logging?
             */
            break;
        }

        default: {
            throw boost::system::system_error(ec);
        }
    }

    return bytes_sent;
};

References endpoint, NO_FLAGS, and socket.

Here is the caller graph for this function:

set_receiver_endpoint()

void travesim::udp::Sender::set_receiver_endpoint	(	const std::string	receiver_address,
		const short	receiver_port
	)

Set the receiver endpoint object.

Parameters

receiver_address	Address where to send data
receiver_port	Port where to send data

Definition at line 68 of file sender.cpp.

                                                                                              {
    const boost::asio::ip::address receiver_boost_addr = boost::asio::ip::address::from_string(receiver_address);

    this->endpoint = boost::asio::ip::udp::endpoint(receiver_boost_addr, receiver_port);
};

References endpoint.

Here is the caller graph for this function:

Member Data Documentation

endpoint

boost::asio::ip::udp::endpoint travesim::udp::Sender::endpoint

protected

Multicast address and port pair

Definition at line 60 of file sender.hpp.

io_context

boost::asio::io_context travesim::udp::Sender::io_context

private

boost/asio I/O execution context

Definition at line 63 of file sender.hpp.

socket

boost::asio::ip::udp::socket* travesim::udp::Sender::socket

protected

Network socket

Definition at line 59 of file sender.hpp.

---

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

• include/travesim_adapters/udp/sender.hpp
• src/lib/udp/sender.cpp