|
| | UDPSocket (AddressFamily family=IPv4) |
| void | sendTo (const void *buffer, size_t len, std::string_view foreignAddress, unsigned short foreignPort) |
| int | receiveFrom (void *buffer, size_t len, std::string &sourceAddress, unsigned short &sourcePort) |
| int | timedReceiveFrom (void *buffer, size_t len, std::string &sourceAddress, unsigned short &sourcePort, int timeout) |
| void | setMulticastTTL (unsigned char multicastTTL) |
| void | setMulticastInterfaceAddr (const std::string &address) |
| void | joinGroup (const std::string &multicastGroup) |
| void | leaveGroup (const std::string &multicastGroup) |
| void | setReuseAddress (bool enable) |
| | Enable or disable local address reuse.
|
| void | connect (std::string_view foreignAddress, unsigned short foreignPort) |
| | establish a connection with the given foreign address and port
|
| int | timedConnect (std::string_view foreignAddress, unsigned short foreignPort, int timeout) |
| | establish a connection with the given foreign address and port
|
| void | bind (unsigned short localPort=0) |
| void | bind (std::string_view localAddress, unsigned short localPort=0) |
| | bind socket to address / port
|
| std::string | getLocalAddress () const |
| unsigned short | getLocalPort () const |
| std::string | getForeignAddress () const |
| unsigned short | getForeignPort () const |
| AddressFamily | addressFamily () const noexcept |
| | return wether this socket was created for IPv4 or IPv6
|
| int | nativeHandle () noexcept |
| | return the native handle of the open socket
|
| int | send (const void *buffer, size_t len) |
| | send data through a connected socket
|
| int | receive (void *buffer, size_t len) |
| | receive data from a bound socket
|
| int | timedReceive (void *buffer, size_t len, int timeout) |
| | receive data from a bound socket, return after the given timespan
|
| void | disconnect () |
| | Disconnect and unset any foreign addresses.
|
| void | shutdown (ShutdownDirection type) |
| | shutdown the connection in the specified direction
|
| bool | peerDisconnected () const noexcept |
| | returns whether a currently associated peer disconnected
|
UDP socket class.
- Examples
- UDP_Commands.cpp, and UDP_Multicast.cpp.
Definition at line 9 of file UDPSocket.h.
| void InternetSocket::bind |
( |
std::string_view | localAddress, |
|
|
unsigned short | localPort = 0 ) |
|
inherited |
bind socket to address / port
Set the local port to the specified port and the local address to an interface.
bind() attaches the local endpoint of the socket to the specified interface and port. Typically all servers use bind() to attach to the local port specified by the used protocol. You just need to call bind if you want to restrict the connection to a specific local interface, or if you want to listen on a specific port. If you are just a client using connect() to connect to a server, calling bind is most likely unnecessary.
To bind to a port < 1023 you need eighter superuser access, or the SUID bit set on your program.
- Parameters
-
| localAddress | local address |
| localPort | local port |
- Exceptions
-
Definition at line 140 of file InternetSocket.cpp.
| void InternetSocket::connect |
( |
std::string_view | foreignAddress, |
|
|
unsigned short | foreignPort ) |
|
inherited |
establish a connection with the given foreign address and port
If you are using a connection oriented socket (like TCPSocket), you have to call connect() on that socket in order to send data. However, if you are using a non-connection oriented socket (like UDPSocket), calling connect on that socket will allow you to use the send() function like on a connection oriented socket. If not connected, you would have to use sendTo
- Parameters
-
| foreignAddress | foreign address |
| foreignPort | foreign port |
- Exceptions
-
- Examples
- TCP_Client.cpp.
Definition at line 74 of file InternetSocket.cpp.
| void SimpleSocket::disconnect |
( |
| ) |
|
|
inherited |
Disconnect and unset any foreign addresses.
This will ungracefully abort the connection by sending an RST frame. disconnect() should not be used under normal circumstances, as it will terminate the connection OOB, preventing the other end of the communication from retrieving data that would still be available in the OS buffer.
For normal termination of a connection use shutdown().
- Exceptions
-
Definition at line 112 of file SimpleSocket.cpp.
| void SimpleSocket::listen |
( |
int | backlog = 5 | ) |
|
|
protectedinherited |
listen for incoming connections
listen() can be called on a bound socket. The socket will then go into a passive state and accept incoming connections. To answer to an incoming connection call accept() or timedAccept() on the socket.
The backlog is a buffer for incoming connections. If backlog is set to 0, the number of incoming connections is only limited by the operating system. If backlog is set to a value > 0, only the upper limit of connections is set, the OS can limit the number further.
After starting to listen, use accept to accept incoming connections.
- Parameters
-
| backlog | upper limit of pending incoming connections |
- Exceptions
-
Definition at line 137 of file SimpleSocket.cpp.
| bool SimpleSocket::peerDisconnected |
( |
| ) |
const |
|
noexceptinherited |
returns whether a currently associated peer disconnected
For stream sockets this is set when the peer closes or resets the connection. Use this function after a call to receive, returned 0 received bytes.
For connected datagram sockets it may also be set when the network reports that the configured peer is unreachable.
The flag is cleared by a successful connect().
- Returns
- true if a peer disconnected
- Examples
- TCP_Client.cpp.
Definition at line 132 of file SimpleSocket.cpp.
| int SimpleSocket::receive |
( |
void * | buffer, |
|
|
size_t | len ) |
|
inherited |
receive data from a bound socket
receive() can only be used on a socket that called bind() or connect() before. If you try to use receive() on a not bound socket, SocketException will be thrown.
If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.
If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.
If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.
- Parameters
-
| buffer | the buffer the received data will be written to |
| len | length of the provided buffer, receive will not read more than that |
- Returns
- number of bytes received
- Exceptions
-
Definition at line 70 of file SimpleSocket.cpp.
| int SimpleSocket::receiveAll |
( |
void * | buffer, |
|
|
size_t | len ) |
|
protectedinherited |
receive exactly the requested amount unless the peer disconnects
receiveAll() repeatedly calls receive() until len bytes have been received. This is useful for fixed-size data on TCP, where one receive() call is not guaranteed to return all bytes sent by the peer.
If the peer closes or resets the connection before len bytes arrive, the function returns the number of bytes received so far. In that case peerDisconnected() is set by the underlying receive() call.
- Parameters
-
| buffer | buffer the received data will be written to |
| len | number of bytes to receive |
- Returns
- number of bytes received
- Exceptions
-
Definition at line 188 of file SimpleSocket.cpp.
| int SimpleSocket::send |
( |
const void * | buffer, |
|
|
size_t | len ) |
|
inherited |
send data through a connected socket
send() can only be used on a socket that called connect() before. If you try to use send() on a not connected socket, SocketException will be thrown.
If you are using a stream oriented socket (like TCPSocket), the operating system is allowed to send only a part of the packet you told it to send, so send() will return the number of bytes actually sent. It is your responsibility to resend the data not sent by send()
If you are using a datagram oriented socket (like UDPSocket or SCTPSocket) the operating system will only send and receive complete datagrams, but send() will fail if you are trying to send too much data. In that case SocketException will be thrown.
- Parameters
-
| buffer | data to be send |
| len | length of the data to be sent |
- Returns
- number of bytes sent
- Exceptions
-
Definition at line 50 of file SimpleSocket.cpp.
| int SimpleSocket::sendAll |
( |
const void * | buffer, |
|
|
size_t | len ) |
|
protectedinherited |
send data through a connected socket
sendAll() can only be used on a socket that called connect() before. If you try to use sendAll() on a unconnected socket, a SocketException will be thrown.
When using a stream oriented socket, the operating system is allowed to send only a bit of the data you requested it to send. Because of this, you would have to check the number of sent bytes when using send(), and resend unsent data manually. sendAll() takes that responsibility from you and resends as long as it needs, to completely send the data given to it.
- Parameters
-
| buffer | data to be send |
| len | length of the data to be sent |
- Returns
- number of bytes sent
- Exceptions
-
Definition at line 175 of file SimpleSocket.cpp.
| void UDPSocket::sendTo |
( |
const void * | buffer, |
|
|
size_t | len, |
|
|
std::string_view | foreignAddress, |
|
|
unsigned short | foreignPort ) |
Send the given buffer as a UDP datagram to the specified address / port.
Can be substituted with send() if the socket is first connected to an address and port. If sendTo() is used on a connected socket, the destination parameters will be ignored, and the datagram will be sent to the connected socket.
If the message you are trying to send is too long for one of the underlying protocols a SocketException will be thrown. Like send(), sendTo() blocks until the message was sent.
- Parameters
-
| buffer | data to be send |
| len | number of bytes to write |
| foreignAddress | address to send to |
| foreignPort | port number to send to |
- Exceptions
-
- Examples
- UDP_Commands.cpp, and UDP_Multicast.cpp.
Definition at line 38 of file UDPSocket.cpp.
shutdown the connection in the specified direction
This will gracefully end a connection by sending a FIN frame. Use this to end a normal communication cycle. To abort a connection see disconnect().
Depending on the specified ShutdownDirection, calls for that direction will stop working. Use this function if you want to have more control than just destroing the socket. It allows you to cut the connection in one direction, or both.
If you use shutdown() on an unconnected socket, the corresponding calls will simply stop working.
- Parameters
-
- Exceptions
-
- Examples
- TCP_Server.cpp.
Definition at line 126 of file SimpleSocket.cpp.
| int SimpleSocket::timedReceive |
( |
void * | buffer, |
|
|
size_t | len, |
|
|
int | timeout ) |
|
inherited |
receive data from a bound socket, return after the given timespan
timedReceive() can only be used on a socket that called bind() or connect before. If you try to use receive() on a not bound socket, SocketException will be thrown.
If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.
If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.
If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.
- Parameters
-
| buffer | the buffer the received data will be written to |
| len | length of the provided buffer, receive will not read more than that |
| timeout | the timeout in ms after which receive will give up and return |
- Returns
- number of bytes received, 0 on timeout
- Exceptions
-
- Examples
- TCP_Client.cpp.
Definition at line 89 of file SimpleSocket.cpp.
| int UDPSocket::timedReceiveFrom |
( |
void * | buffer, |
|
|
size_t | len, |
|
|
std::string & | sourceAddress, |
|
|
unsigned short & | sourcePort, |
|
|
int | timeout ) |
Read up to len bytes data from this socket. The given buffer is where the data will be placed. If no host has sent a datagram before the timeout runs out, the function will return without changing the buffer.
In order to receive data, the socket has to be bound at least to a specific port. This is done by explicitly binding the socket, or sending data through the socket.
- Parameters
-
| buffer | buffer to receive data |
| len | maximum number of bytes to receive |
| sourceAddress | address of datagram source |
| sourcePort | port of data source |
| timeout | timeout in milliseconds |
- Returns
- number of bytes received, 0 on timeout
- Exceptions
-
- Examples
- UDP_Multicast.cpp.
Definition at line 63 of file UDPSocket.cpp.
1.16.1