libosmocore  1.0.1
Osmocom core library
socket.h
Go to the documentation of this file.
1 
4 #pragma once
5 
10 #include <stdint.h>
11 #include <stdbool.h>
12 #include <stddef.h>
13 
14 struct sockaddr_in;
15 struct sockaddr;
16 struct osmo_fd;
17 
18 /* flags for osmo_sock_init. */
20 #define OSMO_SOCK_F_CONNECT (1 << 0)
21 
22 #define OSMO_SOCK_F_BIND (1 << 1)
23 
24 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
25 
26 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
27 
28 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
29 
30 #define OSMO_SOCK_F_UDP_REUSEADDR (1 << 5)
31 
32 #define OSMO_SOCK_NAME_MAXLEN (2 + INET6_ADDRSTRLEN + 1 + 5 + 3 + 2 + INET6_ADDRSTRLEN + 1 + 5 + 1)
33 
34 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
35  const char *host, uint16_t port, unsigned int flags);
36 
37 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
38  const char *local_host, uint16_t local_port,
39  const char *remote_host, uint16_t remote_port, unsigned int flags);
40 
41 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
42  const char *host, uint16_t port, unsigned int flags);
43 
44 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
45  const char *local_host, uint16_t local_port,
46  const char *remote_host, uint16_t remote_port, unsigned int flags);
47 
48 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
49  uint8_t proto, unsigned int flags);
50 
51 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
52 
53 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
54  const struct sockaddr *sa);
55 size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
56  const struct sockaddr_in *sin);
57 
58 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
59  const char *socket_path, unsigned int flags);
60 
61 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
62  const char *socket_path, unsigned int flags);
63 
64 char *osmo_sock_get_name(void *ctx, int fd);
65 const char *osmo_sock_get_name2(int fd);
66 int osmo_sock_get_name_buf(char *str, size_t str_len, int fd);
67 int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local);
68 int osmo_sock_get_local_ip(int fd, char *host, size_t len);
69 int osmo_sock_get_local_ip_port(int fd, char *port, size_t len);
70 int osmo_sock_get_remote_ip(int fd, char *host, size_t len);
71 int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len);
72 
73 
74 int osmo_sock_mcast_loop_set(int fd, bool enable);
75 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
76 int osmo_sock_mcast_all_set(int fd, bool enable);
77 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
78 
79 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
80 
int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
Get local port on socket.
Definition: socket.c:750
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:598
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:441
int osmo_sock_get_remote_ip(int fd, char *host, size_t len)
Get remote IP address on socket.
Definition: socket.c:761
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:854
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".
Definition: socket.c:801
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:579
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:709
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:879
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:973
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:462
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:314
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:901
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:933
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:480
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:549
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:182
char * osmo_sock_get_name(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)".
Definition: socket.c:784
int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
Get remote port on socket.
Definition: socket.c:772
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:115
int osmo_sock_get_local_ip(int fd, char *host, size_t len)
Get local IP address on socket.
Definition: socket.c:739
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:617
Structure representing a file dsecriptor.
Definition: select.h:23
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:694
int fd
actual operating-system level file decriptor
Definition: select.h:27
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".
Definition: socket.c:823