Async Comm
A library for asynchronous serial communication
Public Member Functions | List of all members
async_comm::TCPClient Class Reference

Asynchronous communication class for a TCP client. More...

#include <tcp_client.h>

Inheritance diagram for async_comm::TCPClient:
async_comm::Comm

Public Member Functions

 TCPClient (std::string host=DEFAULT_HOST, uint16_t port=DEFAULT_PORT, MessageHandler &message_handler=default_message_handler_)
 Connect to a TCP socket as a client. 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
MessageHandlermessage_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

Asynchronous communication class for a TCP client.

Definition at line 56 of file tcp_client.h.

Constructor & Destructor Documentation

§ TCPClient()

async_comm::TCPClient::TCPClient ( std::string  host = DEFAULT_HOST,
uint16_t  port = DEFAULT_PORT,
MessageHandler message_handler = default_message_handler_ 
)

Connect to a TCP socket as a client.

Parameters
hostThe host where the TCP server is running
portThe port on which the TCP server is listening
message_handlerCustom message handler, or omit for default handler

Definition at line 47 of file tcp_client.cpp.


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