SCTP socket class. More...
#include <simple_socket/SCTPSocket.h>
Public Types | |
| enum | abortFlag { ABORT = SCTP_ABORT , SHUTDOWN = SCTP_EOF , KEEPALIVE = 0 } |
| enum | switchAddressFlag { KEEP_PRIMARY = 0 , OVERRIDE_PRIMARY = SCTP_ADDR_OVER } |
| enum | receiveFlag |
Public Member Functions | |
| SCTPSocket (uint16_t numOutStreams=10, uint16_t maxInStreams=65535, uint16_t maxAttempts=4, uint16_t maxInitTimeout=0) | |
| int | bind (const std::vector< std::string > &localAddresses, unsigned short localPort=0) |
| int | connect (const std::vector< std::string > &foreignAddresses, unsigned short foreignPort=0) |
| int | state () const |
| int | notAckedData () const |
| int | pendingData () const |
| unsigned | inStreams () const |
| unsigned | outStreams () const |
| unsigned | fragmentationPoint () const |
| std::string | primaryAddress () const |
| IOResult | send (const void *data, size_t length, uint16_t stream, unsigned ttl=0, unsigned context=0, unsigned ppid=0, abortFlag abort=KEEPALIVE, switchAddressFlag switchAddr=KEEP_PRIMARY) |
| IOResult | sendUnordered (const void *data, size_t length, uint16_t stream, unsigned ttl=0, unsigned context=0, unsigned ppid=0, abortFlag abort=KEEPALIVE, switchAddressFlag switchAddr=KEEP_PRIMARY) |
| IOResult | receive (void *data, size_t maxLen, uint16_t &stream) |
| IOResult | receive (void *data, size_t maxLen, uint16_t &stream, receiveFlag &flag) |
| IOResult | timedReceive (void *data, size_t maxLen, uint16_t &stream, int timeout) |
| IOResult | timedReceive (void *data, size_t maxLen, uint16_t &stream, receiveFlag &flag, int timeout) |
| std::optional< SCTPSocket > | accept () const |
| std::optional< SCTPSocket > | timedAccept (int timeout) const |
| IOResult | send (const void *buffer, size_t len) |
| send data through a connected socket | |
| void | listen (int backlog=128) |
| listen for incoming connections | |
| ConnectResult | finishConnect (int timeout=0) |
| check if a previously started connected attempt is finished | |
| void | setReuseAddress (bool enable) |
| Enable or disable local address reuse. | |
| ConnectResult | connect (std::string_view foreignAddress, unsigned short foreignPort) |
| establish a connection with the given foreign address and port | |
| ConnectResult | 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 descriptor. Ownership remains with the object. | |
| int | duplicateNativeHandle () const |
| Duplicates the underlaying native socket descriptor. | |
| bool | valid () const noexcept |
| Returns true if socket is in a usable (non-moved) state and open. | |
| IOResult | receive (void *buffer, size_t len) |
| receive data from a bound socket | |
| IOResult | 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. | |
| bool | isConnected () const |
| check if the kernel currently has an associated peer address | |
| void | shutdown (ShutdownDirection type) |
| shutdown the connection in the specified direction | |
| bool | peerDisconnected () const |
| returns whether a currently associated peer disconnected | |
| bool | isBlocking () const |
| returns true if socket is in blocking mode | |
| void | setBlocking (bool blocking) |
| set socket to blocking or non-blocking I/O operations | |
| void | setSendBufferSize (int bytes) |
| override default send buffer size for this socket | |
| void | setReceiveBufferSize (int bytes) |
| override default receive buffer size for this socket | |
Protected Member Functions | |
| void | setInitValues (uint16_t ostr, uint16_t istr, uint16_t att, uint16_t time) |
| InternetSocket (AddressFamily family, int type, int protocol) | |
| allows a subclass to create new socket | |
| InternetSocket (AdoptSocketTag, int sockfd, int type) | |
| allows a subclass to take ownership of an existing socket | |
| InternetSocket (InternetSocket &&other) noexcept=default | |
| IOResult | sendAll (const void *buffer, size_t len) |
| send data through a connected socket | |
| IOResult | receiveAll (void *buffer, size_t len) |
| receive exactly the requested amount unless the peer disconnects | |
Protected Attributes | |
| AddressFamily | m_family |
| int | m_socket |
| bool | m_connectionOriented |
SCTP socket class.
Definition at line 14 of file SCTPSocket.h.
| Enumerator | |
|---|---|
| ABORT | |
| SHUTDOWN | |
| KEEPALIVE | |
Definition at line 17 of file SCTPSocket.h.
Definition at line 30 of file SCTPSocket.h.
| Enumerator | |
|---|---|
| KEEP_PRIMARY | |
| OVERRIDE_PRIMARY | |
Definition at line 24 of file SCTPSocket.h.
| NET::SCTPSocket::SCTPSocket | ( | uint16_t | numOutStreams = 10, |
| uint16_t | maxInStreams = 65535, | ||
| uint16_t | maxAttempts = 4, | ||
| uint16_t | maxInitTimeout = 0 ) |
| std::optional< SCTPSocket > NET::SCTPSocket::accept | ( | ) | const |
|
inlinenoexceptinherited |
return wether this socket was created for IPv4 or IPv6
Definition at line 117 of file InternetSocket.h.
|
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.
| localAddress | local address |
| localPort | local port |
| SocketException | thrown if setting local port fails |
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Instead of the richer function with more arguments, this bind() binds to any available interface / address
| int NET::SCTPSocket::bind | ( | const std::vector< std::string > & | localAddresses, |
| unsigned short | localPort = 0 ) |
|
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.
| foreignAddress | foreign address |
| foreignPort | foreign |
| SocketException | thrown if unable to establish connection |
| int NET::SCTPSocket::connect | ( | const std::vector< std::string > & | foreignAddresses, |
| unsigned short | foreignPort = 0 ) |
|
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().
| SocketException | thrown if unable to disconnect |
|
nodiscardinherited |
Duplicates the underlaying native socket descriptor.
| ConnectResult NET::SimpleSocket::finishConnect | ( | int | timeout = 0 | ) |
check if a previously started connected attempt is finished
Use this to check if a non-blocking connect() call has completed.
| timeout | the timeout in ms after which we stop waiting, connection is still active |
| SocketException |
| unsigned NET::SCTPSocket::fragmentationPoint | ( | ) | const |
|
inherited |
Get the foreign address. Call connect() before using this function.
| SocketException | thrown if unable to fetch foreign address |
|
inherited |
Get the foreign port. Call connect() before using this function.
| SocketException | thrown if unable to fetch foreign port |
|
inherited |
Get the local address (after binding the socket).
| SocketException | thrown if fetch fails |
|
inherited |
Get the local port (after binding the socket).
| SocketException | thrown if fetch fails |
| unsigned NET::SCTPSocket::inStreams | ( | ) | const |
|
protected |
allows a subclass to create new socket
|
protected |
allows a subclass to take ownership of an existing socket
|
protecteddefaultnoexcept |
|
nodiscardinherited |
returns true if socket is in blocking mode
|
nodiscardinherited |
check if the kernel currently has an associated peer address
For stream sockets, true means a peer association exists; it does not guarantee that the remote endpoint is alive or that I/O can succeed. A peer that has sent FIN may still be associated with the socket.
For datagram sockets, true only indicates that connect() configured a default peer address; it does not establish a network connection.
| SocketException | for other getpeername() errors |
| void NET::SimpleSocket::listen | ( | int | backlog = 128 | ) |
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 specifies the maximum requested number of pending connections waiting to be accepted.
| backlog | requested pending connection queue size |
| SocketException |
|
inlinenoexceptinherited |
Return the native descriptor. Ownership remains with the object.
Definition at line 128 of file SimpleSocket.h.
| int NET::SCTPSocket::notAckedData | ( | ) | const |
| unsigned NET::SCTPSocket::outStreams | ( | ) | const |
|
nodiscardinherited |
returns whether a currently associated peer disconnected
Returns whether the OS currently reports hangup or error for the stream peer. A false result does not guarantee that the remote peer is reachable.
| int NET::SCTPSocket::pendingData | ( | ) | const |
| std::string NET::SCTPSocket::primaryAddress | ( | ) | const |
| IOResult NET::SCTPSocket::receive | ( | void * | data, |
| size_t | maxLen, | ||
| uint16_t & | stream ) |
| IOResult NET::SCTPSocket::receive | ( | void * | data, |
| size_t | maxLen, | ||
| uint16_t & | stream, | ||
| receiveFlag & | flag ) |
|
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) receive() will return PeerDisconnected in the result status. If you are using a connectionless protocol (like UDP) you may get DestinationUnavailable in the result status when the peer refuses via ICMP.
| buffer | the buffer the received data will be written to |
| len | length of the provided buffer, receive will not read more than that |
| SocketException | in case an error occured |
|
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 an error status with the number of bytes received so far.
| buffer | buffer the received data will be written to |
| len | number of bytes to receive |
| SocketException | on receive errors other than peer loss |
| IOResult NET::SimpleSocket::send | ( | const void * | buffer, |
| size_t | len ) |
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.
| buffer | data to be send |
| len | length of the data to be sent |
| SocketException | if sending went wrong |
| IOResult NET::SCTPSocket::send | ( | const void * | data, |
| size_t | length, | ||
| uint16_t | stream, | ||
| unsigned | ttl = 0, | ||
| unsigned | context = 0, | ||
| unsigned | ppid = 0, | ||
| abortFlag | abort = KEEPALIVE, | ||
| switchAddressFlag | switchAddr = KEEP_PRIMARY ) |
|
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 part 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.
| buffer | data to be send |
| len | length of the data to be sent |
| SocketException |
| IOResult NET::SCTPSocket::sendUnordered | ( | const void * | data, |
| size_t | length, | ||
| uint16_t | stream, | ||
| unsigned | ttl = 0, | ||
| unsigned | context = 0, | ||
| unsigned | ppid = 0, | ||
| abortFlag | abort = KEEPALIVE, | ||
| switchAddressFlag | switchAddr = KEEP_PRIMARY ) |
|
inherited |
set socket to blocking or non-blocking I/O operations
A non-blocking socket will return from all I/O operations right away. The IOStatus WouldBlock is used to signify no work can be done at the moment. An event handler can use poll(), epoll(), etc. to monitor the socket for readyness for the next operation.
All timed operations provided by socket classes are not affected. Timed calls wait up to timeout ms for even with non-blocking sockets.
|
protected |
|
inherited |
override default receive buffer size for this socket
|
inherited |
Enable or disable local address reuse.
SO_REUSEADDR allows binding a local address that may still be associated with previous connections, e.g. TCP connections in TIME_WAIT. This option should be set before bind().
| enable | true to enable address reuse |
| SocketException | if changing the option fails |
|
inherited |
override default send buffer size for this socket
|
inherited |
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.
| type | the ShutdownDirection that be used |
| SocketException | in case an error occured |
| int NET::SCTPSocket::state | ( | ) | const |
| std::optional< SCTPSocket > NET::SCTPSocket::timedAccept | ( | int | timeout | ) | const |
|
inherited |
establish a connection with the given foreign address and port
Provides timeout for TCP socket connection establishment. When a timeout occurs, the OS may still continue the connection attempt in the background. Use disconnect() or destroy the socket to avoid this.
| foreignAddress | foreign address |
| foreignPort | foreign port |
| timeout | the timeout in ms after which connect will give up and return |
| SocketException | thrown if unable to establish connection |
| IOResult NET::SCTPSocket::timedReceive | ( | void * | data, |
| size_t | maxLen, | ||
| uint16_t & | stream, | ||
| int | timeout ) |
| IOResult NET::SCTPSocket::timedReceive | ( | void * | data, |
| size_t | maxLen, | ||
| uint16_t & | stream, | ||
| receiveFlag & | flag, | ||
| 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) receive() will return PeerDisconnected in the result status. If you are using a connectionless protocol (like UDP) you may get DestinationUnavailable in the result status when the peer refuses via ICMP.
| 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 |
| SocketException | in case an error occured |
|
noexceptinherited |
Returns true if socket is in a usable (non-moved) state and open.
|
protectedinherited |
Definition at line 395 of file SimpleSocket.h.
|
protectedinherited |
Definition at line 130 of file InternetSocket.h.
|
protectedinherited |
Definition at line 394 of file SimpleSocket.h.