Asynchronous communication class for a UDP socket. More...
#include <udp.h>
Inheritance diagram for async_comm::UDP:
Collaboration 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, MessageHandler &message_handler=default_message_handler_) | |
| Bind a UDP socket. More... | |
 Public Member Functions inherited from async_comm::Comm | |
| Comm (MessageHandler &message_handler=default_message_handler_) | |
| Set up asynchronous communication base class. More... | |
| bool | init () |
| Initializes and opens the port. More... | |
| void | close () |
| Closes the port. | |
| void | send_bytes (const uint8_t *src, size_t len) |
| Send bytes from a buffer over the port. More... | |
| void | send_byte (uint8_t data) |
| Send a single byte over 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 | register_listener (CommListener &listener) |
| Register a listener for when bytes are received on the port. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from async_comm::Comm | |
| MessageHandler & | message_handler_ |
| 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 |
| static DefaultMessageHandler | default_message_handler_ |
Detailed Description
Constructor & Destructor Documentation
◆ UDP()
| 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, |
||
| MessageHandler & | message_handler = default_message_handler_ |
||
| ) |
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 message_handler Custom message handler, or omit for default handler
The documentation for this class was generated from the following files:
