libosmocore  0.12.0
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 
13 struct sockaddr;
14 struct osmo_fd;
15 
16 /* flags for osmo_sock_init. */
18 #define OSMO_SOCK_F_CONNECT (1 << 0)
19 
20 #define OSMO_SOCK_F_BIND (1 << 1)
21 
22 #define OSMO_SOCK_F_NONBLOCK (1 << 2)
23 
24 #define OSMO_SOCK_F_NO_MCAST_LOOP (1 << 3)
25 
26 #define OSMO_SOCK_F_NO_MCAST_ALL (1 << 4)
27 
28 int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
29  const char *host, uint16_t port, unsigned int flags);
30 
31 int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
32  const char *local_host, uint16_t local_port,
33  const char *remote_host, uint16_t remote_port, unsigned int flags);
34 
35 int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
36  const char *host, uint16_t port, unsigned int flags);
37 
38 int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
39  const char *local_host, uint16_t local_port,
40  const char *remote_host, uint16_t remote_port, unsigned int flags);
41 
42 int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
43  uint8_t proto, unsigned int flags);
44 
45 int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
46 
47 unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
48  const struct sockaddr *sa);
49 
50 int osmo_sock_unix_init(uint16_t type, uint8_t proto,
51  const char *socket_path, unsigned int flags);
52 
53 int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
54  const char *socket_path, unsigned int flags);
55 
56 char *osmo_sock_get_name(void *ctx, int fd);
57 
58 int osmo_sock_mcast_loop_set(int fd, bool enable);
59 int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl);
60 int osmo_sock_mcast_all_set(int fd, bool enable);
61 int osmo_sock_mcast_subscribe(int fd, const char *grp_addr);
62 
63 int osmo_sock_local_ip(char *local_ip, const char *remote_ip);
64 
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:564
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:426
int osmo_sock_mcast_loop_set(int fd, bool enable)
Activate or de-activate local loop-back of transmitted multicast packets.
Definition: socket.c:731
int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
Set the TTL of outbound multicast packets.
Definition: socket.c:756
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:850
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:447
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:310
int osmo_sock_mcast_all_set(int fd, bool enable)
Enable/disable receiving all multicast packets, even for non-subscribed groups.
Definition: socket.c:778
int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
Subscribe to the given IP multicast group.
Definition: socket.c:810
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:465
int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Determine if the given address is a local address.
Definition: socket.c:534
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 soocket in dyn-alloc string.
Definition: socket.c:671
uint8_t type
see GSMTAP_TYPE_*
Definition: gsmtap.h:115
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:587
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:660
int fd
actual operating-system level file decriptor
Definition: select.h:27