-/*
- * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
/** \file net.c Networking-related helper functions. */
* default of 32 if not specified.
*
* \return Pointer to \a addr if successful, NULL on error.
- * \sa RFC 4632
+ * \sa RFC 4632.
*/
char *parse_cidr(const char *cidr,
char *addr, ssize_t addrlen,
* \param host The host string to check.
* \return True if \a host passes the syntax checks.
*
- * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5
+ * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5.
*/
static bool host_string_ok(const char *host)
{
* \a host and \a port are undefined. If no port number was present in \a url,
* \a port is set to -1.
*
- * \sa RFC 3986, 3.2.2/3.2.3
+ * \sa RFC 3986, 3.2.2/3.2.3.
*/
char *parse_url(const char *url,
char *host, ssize_t hostlen,
* \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
* \return Pointer to static result buffer.
*
- * \sa getservent(3), services(5), nsswitch.conf(5)
+ * \sa getservent(3), services(5), nsswitch.conf(5).
*/
const char *stringify_port(int port, const char *transport)
{
*
* \param l4type The symbolic name of the transport-layer protocol.
*
- * \sa ip(7), socket(2)
+ * \sa ip(7), socket(2).
*/
static inline int sock_type(const unsigned l4type)
{
* directly after makesock(). The 'pre_conn_opt' structure is for internal use
* only and should not be visible elsewhere.
*
- * \sa setsockopt(2), makesock()
+ * \sa setsockopt(2), \ref makesock().
*/
struct pre_conn_opt {
int sock_level; /**< Second argument to setsockopt() */
* \param val The value to set \a opt to.
* \param len Length of \a val.
*
- * \sa setsockopt(2)
+ * \sa setsockopt(2).
*/
void flowopt_add(struct flowopts *fo, int lev, int opt,
const char *name, const void *val, int len)
* \return Positive integer (socket descriptor) on success, negative value
* otherwise.
*
- * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
+ * \sa \ref makesock(), ip(7), ipv6(7), bind(2), listen(2).
*/
int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
{
* \param ss Container of IPv4/6 address.
* \return Pointer to normalized address (may be static storage).
*
- * \sa RFC 3493
+ * \sa RFC 3493.
*/
static const struct sockaddr *
normalize_ip_address(const struct sockaddr_storage *ss)
* \return A static character string identifying hostname and port of the
* chosen side in numeric host:port format.
*
- * \sa getsockname(2), getpeername(2), parse_url(), getnameinfo(3),
+ * \sa getsockname(2), getpeername(2), \ref parse_url(), getnameinfo(3),
* services(5), nsswitch.conf(5).
*/
char *remote_name(int fd)
*
* \return The return value of the underlying call to \a recv_bin_buffer().
*
- * \sa recv_bin_buffer()
+ * \sa \ref recv_bin_buffer()
*/
int recv_buffer(int fd, char *buf, size_t size)
{
* \return The file descriptor of the connected socket on success, negative on
* errors.
*
- * \sa create_local_socket(), unix(7), connect(2).
+ * \sa \ref create_local_socket(), unix(7), connect(2).
*/
int connect_local_socket(const char *name)
{
* \return On success, this call returns the number of bytes sent. On errors,
* \p -E_SENDMSG is returned.
*
- * \sa \ref recv_cred_buffer, sendmsg(2), socket(7), unix(7), okir's Black Hats
- * Manual.
+ * \sa \ref recv_cred_buffer, sendmsg(2), socket(7), unix(7).
*/
ssize_t send_cred_buffer(int sock, char *buf)
{