socket.h
Go to the documentation of this file.
#pragma once
#if (!EMBEDDED)
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <arpa/inet.h>
#define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
struct sockaddr_in;
struct sockaddr;
struct osmo_fd;
struct osmo_sockaddr {
union {
struct sockaddr sa;
struct sockaddr_storage sas;
struct sockaddr_in sin;
struct sockaddr_in6 sin6;
} u;
};
/* flags for osmo_sock_init. */
#define OSMO_SOCK_F_CONNECT (1 << 0)
#define OSMO_SOCK_F_BIND (1 << 1)
#define OSMO_SOCK_F_NONBLOCK (1 << 2)
#define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
#define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
#define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
#define OSMO_SOCK_F_DSCP(x) (((x)&0x3f) << 24)
#define GET_OSMO_SOCK_F_DSCP(f) (((f) >> 24) & 0x3f)
#define OSMO_SOCK_F_PRIO(x) (((x)&0xff) << 16)
#define GET_OSMO_SOCK_F_PRIO(f) (((f) >> 16) & 0xff)
#define OSMO_SOCK_MAX_ADDRS 32
int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
const char *host, uint16_t port, unsigned int flags);
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);
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);
int osmo_sock_init_osa(uint16_t type, uint8_t proto,
const struct osmo_sockaddr *local,
const struct osmo_sockaddr *remote,
unsigned int flags);
int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
const char *host, uint16_t port, unsigned int flags);
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);
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);
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr *sa);
size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
const struct sockaddr_in *sin);
const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst);
uint16_t osmo_sockaddr_port(const struct sockaddr *sa);
int osmo_sock_unix_init(uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags);
int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
const char *socket_path, unsigned int flags);
char *osmo_sock_get_name(const void *ctx, int fd);
const char *osmo_sock_get_name2(int fd);
char *osmo_sock_get_name2_c(const void *ctx, int fd);
int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
int osmo_sock_get_local_ip(int fd, char *host, size_t len);
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
int osmo_sock_mcast_loop_set(int fd, bool enable);
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
int osmo_sock_mcast_all_set(int fd, bool enable);
int osmo_sock_mcast_iface_set(int fd, const char *ifname);
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip,
const struct osmo_sockaddr *remote_ip);
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
const struct osmo_sockaddr *b);
const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr);
char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
const struct osmo_sockaddr *sockaddr);
int osmo_sock_set_dscp(int fd, uint8_t dscp);
int osmo_sock_set_priority(int fd, int prio);
#endif /* (!EMBEDDED) */
type
enum osmo_sub_auth_type type
len
static size_t len(const char *str)
osmo_sockaddr_cmp
int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
Compare two osmo_sockaddr.
Definition: socket.c:1745
osmo_sockaddr_in_to_str_and_uint
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.
Definition: socket.c:1189
osmo_sock_init_osa
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)
Definition: socket.c:520
osmo_sock_get_local_ip
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
Get local IP address on socket.
Definition: socket.c:1391
osmo_sockaddr_ntop
const char * osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
inet_ntop() wrapper for a struct sockaddr.
Definition: socket.c:1235
osmo_sockaddr_to_str_buf
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
Definition: socket.c:1788
osmo_sockaddr_port
uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
Get sockaddr port content (in host byte order)
Definition: socket.c:1249
osmo_sock_get_name2_c
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....
Definition: socket.c:1489
osmo_sock_get_name
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....
Definition: socket.c:1436
osmo_sockaddr_local_ip
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.
Definition: socket.c:1722
osmo_sock_get_name_buf
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....
Definition: socket.c:1453
osmo_sock_set_priority
int osmo_sock_set_priority(int fd, int prio)
Set the priority value of a socket.
Definition: socket.c:1889
osmo_sock_mcast_loop_set
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:1522
osmo_sock_get_ip_and_port
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.
Definition: socket.c:1361
osmo_sock_init2_multiaddr
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.
Definition: socket.c:720
osmo_sock_get_local_ip_port
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
Get local port on socket.
Definition: socket.c:1402
osmo_sock_init
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)
Definition: socket.c:893
osmo_sock_init_ofd
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.
Definition: socket.c:1022
osmo_sock_init2_ofd
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.
Definition: socket.c:1043
osmo_sockaddr_to_str
const char * osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
string-format a given osmo_sockaddr address
Definition: socket.c:1774
osmo_sock_get_name2
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....
Definition: socket.c:1477
osmo_sock_get_remote_ip_port
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
Get remote port on socket.
Definition: socket.c:1424
osmo_sock_mcast_all_set
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:1590
osmo_sock_get_remote_ip
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
Get remote IP address on socket.
Definition: socket.c:1413
osmo_sockaddr_to_str_and_uint
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.
Definition: socket.c:1208
osmo_sock_init2
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)
Definition: socket.c:311
osmo_sock_unix_init_ofd
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.
Definition: socket.c:1346
osmo_sock_mcast_ttl_set
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:1547
osmo_sock_set_dscp
int osmo_sock_set_dscp(int fd, uint8_t dscp)
Set the DSCP (differentiated services code point) of a socket.
Definition: socket.c:1834
osmo_sockaddr_is_local
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:1156
osmo_sock_mcast_iface_set
int osmo_sock_mcast_iface_set(int fd, const char *ifname)
Set the network device to which we should bind the multicast socket.
Definition: socket.c:1569
osmo_sock_init_osa_ofd
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)
Definition: socket.c:1051
osmo_sock_unix_init
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)
Definition: socket.c:1275
osmo_sock_init_sa
int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, uint8_t proto, unsigned int flags)
Initialize a socket and fill sockaddr.
Definition: socket.c:1068
osmo_sock_local_ip
int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
Determine the matching local IP-address for a given remote IP-Address.
Definition: socket.c:1661
osmo_sock_mcast_subscribe
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:1622
host
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
osmo_sockaddr
Definition: socket.h:24
osmo_sockaddr::sas
struct sockaddr_storage sas
Definition: socket.h:27
osmo_sockaddr::sin
struct sockaddr_in sin
Definition: socket.h:28
osmo_sockaddr::sin6
struct sockaddr_in6 sin6
Definition: socket.h:29
osmo_sockaddr::u
union osmo_sockaddr::@22 u
osmo_sockaddr::sa
struct sockaddr sa
Definition: socket.h:26