Header Only Library
TCP Client
How to use TCP client class
References
#include "IP/InternetProtocol.hpp"
Syntax
Variables
FTcpMessage
Functions
Set Host
- Set the
adress
andport
of host
Get Socket
- Get socket connection properties
Set Max Send Buffer Size
- Set max size in bytes of send buffer
Get Max Send Buffer Size
- Get max size in bytes of send buffer
Set Split Package
- If the size of a message exceeds the maximum allowed size for the send buffer, it will be divided into smaller packets before being sent.
Get Split Package
- Get if Split Package is enabled
Send Str
- Send a string message
- Return false if message is empty or socket is closed
- Warning: If you’re using Windows, ensure that you are sending characters compatible with UTF*8
Send Buffer
- Send a buffer message
- Return false if message is empty or socket is closed
Connect
- Connect to the host
- Return true if It's able to connect
Close
- Close connection
Get Error Code
- Get latest error code
Events
On Connected
- Event triggered when a connection is estabilished
On Bytes Transferred
- Event triggered when socket send or receive data
size_t
: bytes sentsize_t
: bytes received
On Message Sent
- Event triggered when a message is sent
const asio::error_code &
: if error occur, error code will be different from 0
On Message Received
- Event triggered when a message is received
FTcpMessage
: message struct- Use
buffer_to_string()
function to converteraw_data
tostd::string
On Close
- Event triggered when socket is closed
On Error
- Event triggered if any error occur during async process
const asio::error_code &
: if error occur, error code will be different from 0- Normally, when an error occurs, the socket is automatically closed, triggering the
on_close
event.