socket.h File Reference
Socket convenience functions

Osmocom socket convenience functions. More...

`#include <stdint.h>`
`#include <stdbool.h>`
`#include <stddef.h>`
`#include <arpa/inet.h>`

Go to the source code of this file.

## Data Structures

struct | osmo_sockaddr

## Macros

#define | OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
| maximum length of a socket name ("r=1.2.3.4:123<->l=5.6.7.8:987") More...
#define | OSMO_SOCK_F_CONNECT (1 << 0)
| connect the socket to a remote peer More...
#define | OSMO_SOCK_F_BIND (1 << 1)
| bind the socket to a local address/port More...
#define | OSMO_SOCK_F_NONBLOCK (1 << 2)
| switch socket to non-blocking mode More...
#define | OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
| disable multiast loop (IP_MULTICAST_LOOP) More...
#define | OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
| disable receiving all multiast even for non-subscribed groups More...
#define | OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
| use SO_REUSEADDR on UDP ports (required for multicast) More...
#define | OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
| use OSMO_SOCK_F_DSCP(x) to set IP DSCP 'x' for packets transmitted on the socket More...
#define | GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
#define | OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
| use OSMO_SOCK_F_PRIO(x) to set priority 'x' for packets transmitted on the socket More...
#define | GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
#define | OSMO_SOCK_MAX_ADDRS 32
| maximum number of local or remote addresses supported by an osmo_sock instance More...

## Functions

int | osmo_sock_init (uint16_t family, uint16_t type, uint8_t proto, const char *host, uint16_t port, unsigned int flags)
| Initialize a socket (including bind/connect) More...
int | osmo_sock_init2 (uint16_t family, uint16_t type, uint8_t proto, const char *local_host, uint16_t local_port, const char *remote_host, uint16_t remote_port, unsigned int flags)
| Initialize a socket (including bind and/or connect) More...
int | osmo_sock_init2_multiaddr (uint16_t family, uint16_t type, uint8_t proto, const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, unsigned int flags)
| Initialize a socket (including bind and/or connect) with multiple local or remote addresses. More...
int | osmo_sock_init_osa (uint16_t type, uint8_t proto, const struct osmo_sockaddr *local, const struct osmo_sockaddr *remote, unsigned int flags)
| Initialize a socket (including bind and/or connect) More...
int | osmo_sock_init_ofd (struct osmo_fd *ofd, int family, int type, int proto, const char *host, uint16_t port, unsigned int flags)
| Initialize a socket and fill osmo_fd. More...
int | osmo_sock_init2_ofd (struct osmo_fd *ofd, int family, int type, int proto, const char *local_host, uint16_t local_port, const char *remote_host, uint16_t remote_port, unsigned int flags)
| Initialize a socket and fill osmo_fd. More...
int | osmo_sock_init_osa_ofd (struct osmo_fd *ofd, int type, int proto, const struct osmo_sockaddr *local, const struct osmo_sockaddr *remote, unsigned int flags)
int | osmo_sock_init_sa (struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
| Initialize a socket and fill sockaddr. More...
int | osmo_sockaddr_is_local (struct sockaddr *addr, unsigned int addrlen)
| Determine if the given address is a local address. More...
unsigned int | osmo_sockaddr_to_str_and_uint (char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr *sa)
| Convert sockaddr to IP address as char string and port as uint16_t. More...
size_t | osmo_sockaddr_in_to_str_and_uint (char *addr, unsigned int addr_len, uint16_t *port, const struct sockaddr_in *sin)
| Convert sockaddr_in to IP address as char string and port as uint16_t. More...
const char * | osmo_sockaddr_ntop (const struct sockaddr *sa, char *dst)
| inet_ntop() wrapper for a struct sockaddr. More...
uint16_t | osmo_sockaddr_port (const struct sockaddr *sa)
| Get sockaddr port content (in host byte order) More...
int | osmo_sock_unix_init (uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
| Initialize a unix domain socket (including bind/connect) More...
int | osmo_sock_unix_init_ofd (struct osmo_fd *ofd, uint16_t type, uint8_t proto, const char *socket_path, unsigned int flags)
| Initialize a unix domain socket and fill osmo_fd. More...
char * | osmo_sock_get_name (const void *ctx, int fd)
| Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)". More...
const char * | osmo_sock_get_name2 (int fd)
| Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10". More...
char * | osmo_sock_get_name2_c (const void *ctx, int fd)
| Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10". More...
int | osmo_sock_get_name_buf (char *str, size_t str_len, int fd)
| Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10". More...
int | osmo_sock_get_ip_and_port (int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)
| Get the IP and/or port number on socket in separate string buffers. More...
int | osmo_sock_get_local_ip (int fd, char *ip, size_t len)
| Get local IP address on socket. More...
int | osmo_sock_get_local_ip_port (int fd, char *port, size_t len)
| Get local port on socket. More...
int | osmo_sock_get_remote_ip (int fd, char *ip, size_t len)
| Get remote IP address on socket. More...
int | osmo_sock_get_remote_ip_port (int fd, char *port, size_t len)
| Get remote port on socket. More...
int | osmo_sock_mcast_loop_set (int fd, bool enable)
| Activate or de-activate local loop-back of transmitted multicast packets. More...
int | osmo_sock_mcast_ttl_set (int fd, uint8_t ttl)
| Set the TTL of outbound multicast packets. More...
int | osmo_sock_mcast_all_set (int fd, bool enable)
| Enable/disable receiving all multicast packets, even for non-subscribed groups. More...
int | osmo_sock_mcast_iface_set (int fd, const char *ifname)
| Set the network device to which we should bind the multicast socket. More...
int | osmo_sock_mcast_subscribe (int fd, const char *grp_addr)
| Subscribe to the given IP multicast group. More...
int | osmo_sock_local_ip (char *local_ip, const char *remote_ip)
| Determine the matching local IP-address for a given remote IP-Address. More...
int | osmo_sockaddr_local_ip (struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
| Determine the matching local address for a given remote address. More...
int | osmo_sockaddr_cmp (const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
| Compare two osmo_sockaddr. More...
const char * | osmo_sockaddr_to_str (const struct osmo_sockaddr *sockaddr)
| string-format a given osmo_sockaddr address More...
char * | osmo_sockaddr_to_str_buf (char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
| string-format a given osmo_sockaddr address into a user-supplied buffer More...
int | osmo_sock_set_dscp (int fd, uint8_t dscp)
| Set the DSCP (differentiated services code point) of a socket. More...
int | osmo_sock_set_priority (int fd, int prio)
| Set the priority value of a socket. More...

## Detailed Description

Osmocom socket convenience functions.