blob: d2118ef03c98f86f2e45e878845a2c686aaf940e [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file socket.h
2 * Osmocom socket convenience functions. */
3
Sylvain Munaut12ba7782014-06-16 10:13:40 +02004#pragma once
Harald Welte33cb71a2011-05-21 18:54:32 +02005
Harald Welteba6988b2011-08-17 12:46:48 +02006/*! \defgroup socket Socket convenience functions
7 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02008 * \file socket.h */
Harald Weltebd598e32011-08-16 23:26:52 +02009
Harald Welte33cb71a2011-05-21 18:54:32 +020010#include <stdint.h>
Harald Weltee4764422011-05-22 12:25:57 +020011
12struct sockaddr;
Holger Hans Peter Freyther58d31532012-03-16 09:18:12 +010013struct osmo_fd;
Harald Welte33cb71a2011-05-21 18:54:32 +020014
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020015/* flags for osmo_sock_init. */
Harald Welte2d2e2cc2016-04-25 12:11:20 +020016/*! connect the socket to a remote peer */
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020017#define OSMO_SOCK_F_CONNECT (1 << 0)
Harald Welte2d2e2cc2016-04-25 12:11:20 +020018/*! bind the socket to a local address/port */
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020019#define OSMO_SOCK_F_BIND (1 << 1)
Harald Welte2d2e2cc2016-04-25 12:11:20 +020020/*! switch socket to non-blocking mode */
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020021#define OSMO_SOCK_F_NONBLOCK (1 << 2)
22
Harald Welte33cb71a2011-05-21 18:54:32 +020023int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020024 const char *host, uint16_t port, unsigned int flags);
Harald Welte33cb71a2011-05-21 18:54:32 +020025
Harald Weltedda70fc2017-04-08 20:52:33 +020026int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
27 const char *local_host, uint16_t local_port,
28 const char *remote_host, uint16_t remote_port, unsigned int flags);
29
Harald Welte68b15742011-05-22 21:47:29 +020030int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020031 const char *host, uint16_t port, unsigned int flags);
Harald Welte68b15742011-05-22 21:47:29 +020032
Pau Espin Pedrol75989e62017-05-26 12:39:53 +020033int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
34 const char *local_host, uint16_t local_port,
35 const char *remote_host, uint16_t remote_port, unsigned int flags);
36
Harald Welte33cb71a2011-05-21 18:54:32 +020037int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020038 uint8_t proto, unsigned int flags);
Harald Welte33cb71a2011-05-21 18:54:32 +020039
Harald Weltee4764422011-05-22 12:25:57 +020040int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen);
Harald Welte33cb71a2011-05-21 18:54:32 +020041
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +010042int osmo_sock_unix_init(uint16_t type, uint8_t proto,
43 const char *socket_path, unsigned int flags);
44
45int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
46 const char *socket_path, unsigned int flags);
47
Harald Welte48f55832017-01-26 00:03:10 +010048char *osmo_sock_get_name(void *ctx, int fd);
49
Sylvain Munautdca7d2c2012-04-18 21:53:23 +020050/*! @} */