* @brief Checks return value for error. * * Every value returned by a syscall is passed to this function. It returns 0 * if the return value is ok

* @brief Checks return value for error. * * Every value returned by a syscall is passed to this function. It returns 0 * if the return value is ok

* @brief Destroys a socket. * * @retval 0 Fine! * @retval <0 Most likely the socket was already closed before. */

* @brief Create a TCP or UDP server socket * * To accept connections from clients via TCP or receive datagrams via UDP, you * need to create a serv

* @brief Close a socket. * * This function closes a socket. You may also use `close(2)`. * * @param sfd The file descriptor * * @retval 0 Closed

* @brief Close a socket * * Actually, it's the same as `close(2)`. * * @param sfd The socket to close. * * @retval 0 Socket could be closed * @

* @brief Receive data from a connected DGRAM socket * * If a datagram socket is connected, this function may be called to receive * data sent from

* @brief Receive datagram from another UNIX socket * * @param sfd The socket descriptor * @param buf The buffer to which the data is written * @pa

* @brief Send data to datagram socket * * @param buf Pointer to data. * @param length Length of `buf` * @param path Path of destination * @param

* @brief Connect a UDP socket. * * If a datagram socket is connected, all data written to it (using `write(2)`) * is sent to the peer connected to

* @brief Creates a new UDP/IP socket * * Returns an integer describing a DGRAM (UDP) socket. The socket is * automatically bound to some port. *

* @brief Create a passive UNIX socket * * Creating a DGRAM server socket is the same as creating one * using `create_unix_dgram_socket()` but with

* @brief Receive data and store the sender's address * * @param buf Receive buffer * @param length Length of `buf` * @param source Buffer for send

* @brief Receive a message and place it into dst. * * No more than dst.size() bytes will be received and placed into dst. */

* @brief Receive data from a UDP/IP socket * * Receives data like `recvfrom(2)`. Pointers may be `NULL`, then the * information (e.g. the source po

* @brief This function is the equivalent to `sendto(2)` * * @param sfd is the *Socket File Descriptor* (every socket file descriptor * argument in

* @brief Send data to connected socket * * @param buf Pointer to the data * @param len The length of the buffer * @param flags Flags for `send(2)`

* @brief Connect a datagram socket * * Connects a datagram socket to the specified socket so the * stream i/o operations may be used (`read(2)/writ

* @brief Create and connect a new TCP/IP socket * * This function returns a working client TCP/IP socket. * * @param host The host the socket will

* @brief Create a UNIX DGRAM socket * * @param bind_path If not `NULL`, bind to `bind_path`. * @param flags Flags to pass to `socket(2)` (varies fr

* @brief Returns the socket file descriptor. * * @return The socket file descriptor of the class. * * getfd() is a getter you may use to obtain th

* @brief Send datagram to socket * * @param sfd Socket * @param buf Data to be sent * @param size The length of the buffer `buf` * @param path De

* @brief Shut a socket down * * Shuts a socket down using `shutdown(2)`. * * @param method `LIBSOCKET_READ/LIBSOCKET_WRITE` or an `OR`ed combinati

* @brief Accept a connection and return a socket connected to the client. * * The caller owns the client socket. * * @param numeric Specifies if t

* @brief Accept a connection attempt on a server socket. * * This function accepts an incoming connection on a server socket. * * (the `src_*` arg

* @brief Accept connections on a passive UNIX socket * * @param sfd The server socket * @param flags Flags for `accept4(3)` (therefore useless on a

* @brief Create and connect a new UNIX STREAM socket. * * Creates and connects a new STREAM socket with the socket given in `path`. * * @retval >0

* @brief Look up which address families a host supports. * * If you want to send a datagram to a host but you don't know * if it supports IPv4 or I

* @brief Accept a connection and return a socket connected to the client. * * Waits for a client to connect and returns a pointer to a inet_stream o

* @brief Connect datagram socket. * * Connect a datagram socket to a remote peer so only its packets are received * and all data written is sent to

* @brief Break association to host. Does not close the socket. * * *Should actually be called 'disconnect'* * */

* @brief Set socket options on the underlying socket. * * @return The return value of setsockopt(2). * * Sets socket options using setsockopt(2).

* @brief Perform a `shutdown(2)` call on a socket * * If you're done with writing or reading from a socket * you may signalize this to the OS and/o

* @brief Shut a socket down * * Shut a socket down for reading or writing. If shut down for * reading, the program can't read anymore. If shut down

* @brief Accepts incoming connections on a UNIX domain stream server socket. * * @param flags Flags for Linux' `accept4()`; useless on other impleme

* @brief Accepts an incoming connection on a UNIX domain stream server socket * and returns an owned pointer. * * The owned pointer will be closed

* @brief Connect socket * * Connects a client stream socket. * * @param path The server socket's path * @param socket_flags Flags for `socket(2)`

* @brief Set up socket if not already done. * * Creates TCP/IP client socket and connects. Fails if the socket is already set * up. * * @param ds

* @brief Connect a UNIX datagram socket * * This function connects a datagram socket; `connect(2)` says the following * about this: * * > If the

* @brief Disconnect a UNIX datagram socket * * Disconnects a previously connected socket. * */

* @brief Set TCP_NODELAY to `!enabled` on the underlying socket. * * TCP_NODELAY causes writes to the socket to be pushed to the network * immediat

* @brief Returns the path we're bound or connected to */

* @deprecated (use is_connected()) * * Look up if socket is connected. */

UTIL *****/ * @brief Utility function to find the highest number in a vector (typically, * the highest file descriptor) */

* @brief Create normal datagram socket (connectable). * * @param proto_osi3 `LIBSOCKET_IPv4` or `LIBSOCKET_IPv6` or `LIBSOCKET_BOTH` * @param flags

* @brief Create datagram socket and bind it. * * @param host Bind address (Wildcard: "0.0.0.0"/"::") * @param port Bind port * @param proto_osi3 `

Void constructor; call connect() before using the socket!

* @brief Void constructor; don't forget to setup() the socket before use! */

* Returns true if the socket is in a connected state. */

* @brief Receive data from socket * * ...and puts it in `buf`. * * @param buf A writable memory buffer of length `len` * @param len Length of `bu

* @brief Receives data from peer * * rcvfrom is the equivalent to `recvfrom(2)`. * * @param buf Target memory * @param len The size of the target

Places up to n bytes into this->RECV_BUF.

* @brief Receive and decode length header. * @returns The expected length received. * @throws socket_exception */