network.h File Reference

#include <errno.h>
#include <stdint.h>
#include "config.h"
#include "libavutil/error.h"
#include "os_support.h"
#include "avio.h"
#include "url.h"
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <netdb.h>

Go to the source code of this file.

Data Structures
struct	sockaddr_storage
union	sockaddr_union
struct	addrinfo

Macros
#define	ff_neterrno()   AVERROR(errno)
#define	MSG_NOSIGNAL   0
#define	EAI_AGAIN   2
#define	EAI_BADFLAGS   3
#define	EAI_FAIL   4
#define	EAI_FAMILY   5
#define	EAI_MEMORY   6
#define	EAI_NODATA   7
#define	EAI_NONAME   8
#define	EAI_SERVICE   9
#define	EAI_SOCKTYPE   10
#define	AI_PASSIVE   1
#define	AI_CANONNAME   2
#define	AI_NUMERICHOST   4
#define	NI_NOFQDN   1
#define	NI_NUMERICHOST   2
#define	NI_NAMERQD   4
#define	NI_NUMERICSERV   8
#define	NI_DGRAM   16
#define	getaddrinfo   ff_getaddrinfo
#define	freeaddrinfo   ff_freeaddrinfo
#define	getnameinfo   ff_getnameinfo
#define	gai_strerror   ff_gai_strerror
#define	INADDR_LOOPBACK   0x7f000001
#define	INET_ADDRSTRLEN   16
#define	INET6_ADDRSTRLEN   INET_ADDRSTRLEN
#define	IN_MULTICAST(a)   ((((uint32_t)(a)) & 0xf0000000) == 0xe0000000)
#define	IN6_IS_ADDR_MULTICAST(a)   (((uint8_t *) (a))[0] == 0xff)
#define	POLLING_TIME   100

Functions
int	ff_socket_nonblock (int socket, int enable)
int	ff_network_init (void)
void	ff_network_close (void)
int	ff_tls_init (void)
void	ff_tls_deinit (void)
int	ff_network_wait_fd (int fd, int write)
int	ff_network_wait_fd_timeout (int fd, int write, int64_t timeout, AVIOInterruptCB *int_cb)
	This works similarly to ff_network_wait_fd, but waits up to 'timeout' microseconds Uses ff_network_wait_fd in a loop. More...
int	ff_network_sleep_interruptible (int64_t timeout, AVIOInterruptCB *int_cb)
	Waits for up to 'timeout' microseconds. More...
int	ff_getaddrinfo (const char *node, const char *service, const struct addrinfo *hints, struct addrinfo **res)
void	ff_freeaddrinfo (struct addrinfo *res)
int	ff_getnameinfo (const struct sockaddr *sa, int salen, char *host, int hostlen, char *serv, int servlen, int flags)
const char *	ff_gai_strerror (int ecode)
int	ff_is_multicast_address (struct sockaddr *addr)
int	ff_listen_bind (int fd, const struct sockaddr *addr, socklen_t addrlen, int timeout, URLContext *h)
	Bind to a file descriptor and poll for a connection. More...
int	ff_listen (int fd, const struct sockaddr *addr, socklen_t addrlen)
	Bind to a file descriptor to an address without accepting connections. More...
int	ff_accept (int fd, int timeout, URLContext *h)
	Poll for a single connection on the passed file descriptor. More...
int	ff_listen_connect (int fd, const struct sockaddr *addr, socklen_t addrlen, int timeout, URLContext *h, int will_try_next)
	Connect to a file descriptor and poll for result. More...
int	ff_http_match_no_proxy (const char *no_proxy, const char *hostname)
int	ff_socket (int domain, int type, int protocol)
void	ff_log_net_error (void *ctx, int level, const char *prefix)
int	ff_connect_parallel (struct addrinfo *addrs, int timeout_ms_per_address, int parallel, URLContext *h, int *fd, void(*customize_fd)(void *, int), void *customize_ctx)
	Connect to any of the given addrinfo addresses, with multiple attempts running in parallel. More...

Macro Definition Documentation

#define ff_neterrno

(

)

AVERROR(errno)

Definition at line 65 of file network.h.

Referenced by ff_accept(), ff_connect_parallel(), ff_listen(), ff_listen_connect(), ff_log_net_error(), ff_network_wait_fd(), ff_poll_interrupt(), rtp_read(), rtp_write(), sctp_open(), sctp_read(), sctp_wait_fd(), sctp_write(), start_connect_attempt(), tcp_get_window_size(), tcp_open(), tcp_read(), tcp_write(), udp_read(), udp_set_multicast_sources(), udp_write(), unix_open(), unix_read(), and unix_write().

#define MSG_NOSIGNAL   0

Definition at line 130 of file network.h.

Referenced by ff_sctp_send(), sctp_write(), tcp_write(), and unix_write().

#define EAI_AGAIN   2

Definition at line 148 of file network.h.

#define EAI_BADFLAGS   3

Definition at line 151 of file network.h.

#define EAI_FAIL   4

Definition at line 154 of file network.h.

#define EAI_FAMILY   5

Definition at line 157 of file network.h.

#define EAI_MEMORY   6

Definition at line 160 of file network.h.

#define EAI_NODATA   7

Definition at line 163 of file network.h.

#define EAI_NONAME   8

Definition at line 166 of file network.h.

#define EAI_SERVICE   9

Definition at line 169 of file network.h.

#define EAI_SOCKTYPE   10

Definition at line 172 of file network.h.

#define AI_PASSIVE   1

Definition at line 176 of file network.h.

Referenced by libsrt_setup(), tcp_open(), and udp_socket_create().

#define AI_CANONNAME   2

Definition at line 180 of file network.h.

#define AI_NUMERICHOST   4

Definition at line 184 of file network.h.

Referenced by ff_tls_open_underlying(), ff_url_join(), and get_sockaddr().

#define NI_NOFQDN   1

Definition at line 188 of file network.h.

#define NI_NUMERICHOST   2

Definition at line 192 of file network.h.

Referenced by ff_connect_parallel(), and print_address_list().

#define NI_NAMERQD   4

Definition at line 196 of file network.h.

#define NI_NUMERICSERV   8

Definition at line 200 of file network.h.

Referenced by ff_connect_parallel(), print_address_list(), and udp_port().

#define NI_DGRAM   16

Definition at line 204 of file network.h.

#define getaddrinfo   ff_getaddrinfo

Definition at line 214 of file network.h.

Referenced by ff_ip_resolve_host(), ff_tls_open_underlying(), ff_url_join(), get_sockaddr(), libsrt_setup(), sap_write_header(), sctp_open(), and tcp_open().

#define freeaddrinfo   ff_freeaddrinfo

Definition at line 215 of file network.h.

Referenced by ff_tls_open_underlying(), ff_url_join(), get_sockaddr(), ip_parse_addr_list(), libsrt_setup(), sap_write_header(), sctp_open(), tcp_open(), udp_set_url(), and udp_socket_create().

#define getnameinfo   ff_getnameinfo

Definition at line 216 of file network.h.

Referenced by ff_connect_parallel(), print_address_list(), and udp_port().

#define gai_strerror   ff_gai_strerror

Definition at line 222 of file network.h.

Referenced by ff_ip_resolve_host(), get_sockaddr(), libsrt_setup(), sctp_open(), tcp_open(), and udp_port().

#define INADDR_LOOPBACK   0x7f000001

Definition at line 226 of file network.h.

#define INET_ADDRSTRLEN   16

Definition at line 230 of file network.h.

#define INET6_ADDRSTRLEN   INET_ADDRSTRLEN

Definition at line 234 of file network.h.

#define IN_MULTICAST

(

a

)

((((uint32_t)(a)) & 0xf0000000) == 0xe0000000)

Definition at line 238 of file network.h.

Referenced by ff_is_multicast_address().

#define IN6_IS_ADDR_MULTICAST

(

a

)

(((uint8_t *) (a))[0] == 0xff)

Definition at line 241 of file network.h.

Referenced by ff_is_multicast_address().

#define POLLING_TIME   100

Definition at line 246 of file network.h.

Referenced by ff_network_sleep_interruptible(), ff_network_wait_fd(), ff_poll_interrupt(), and libsrt_network_wait_fd().

Function Documentation

int ff_socket_nonblock	(	int	socket,
		int	enable
	)

Referenced by ff_accept(), ff_listen_connect(), start_connect_attempt(), and udp_open().

int ff_network_init

(

void

)

Definition at line 58 of file network.c.

Referenced by avformat_network_init(), sap_read_header(), sap_write_header(), and url_alloc_for_protocol().

void ff_network_close

(

void

)

Definition at line 116 of file network.c.

Referenced by avformat_network_deinit(), ffurl_closep(), rtsp_read_close(), rtsp_write_close(), sap_read_close(), sap_write_close(), and url_alloc_for_protocol().

int ff_tls_init

(

void

)

Definition at line 31 of file network.c.

Referenced by avformat_network_init().

void ff_tls_deinit

(

void

)

Definition at line 46 of file network.c.

Referenced by avformat_network_deinit().

int ff_network_wait_fd	(	int	fd,
		int	write
	)

Definition at line 69 of file network.c.

Referenced by ff_network_wait_fd_timeout(), rtp_write(), udp_read(), udp_write(), unix_read(), and unix_write().

int ff_network_wait_fd_timeout	(	int	fd,
		int	write,
		int64_t	timeout,
		AVIOInterruptCB *	int_cb
	)

This works similarly to ff_network_wait_fd, but waits up to 'timeout' microseconds Uses ff_network_wait_fd in a loop.

Parameters

fd	Socket descriptor
write	Set 1 to wait for socket able to be read, 0 to be written
timeout	Timeout interval, in microseconds. Actual precision is 100000 mcs, due to ff_network_wait_fd usage
int_cb	Interrupt callback, is checked before each ff_network_wait_fd call

Returns

0 if data can be read/written, AVERROR(ETIMEDOUT) if timeout expired, or negative error code

Definition at line 78 of file network.c.

Referenced by tcp_read(), and tcp_write().

int ff_network_sleep_interruptible	(	int64_t	timeout,
		AVIOInterruptCB *	int_cb
	)

Waits for up to 'timeout' microseconds.

If the usert's int_cb is set and triggered, return before that.

Parameters

timeout	Timeout in microseconds. Maybe have lower actual precision.
int_cb	Interrupt callback, is checked regularly.

Returns

AVERROR(ETIMEDOUT) if timeout expirted, AVERROR_EXIT if interrupted by int_cb

Definition at line 98 of file network.c.

Referenced by http_read_stream().

int ff_getaddrinfo	(	const char *	node,
		const char *	service,
		const struct addrinfo *	hints,
		struct addrinfo **	res
	)

void ff_freeaddrinfo

(

struct addrinfo *

res

)

int ff_getnameinfo	(	const struct sockaddr *	sa,
		int	salen,
		char *	host,
		int	hostlen,
		char *	serv,
		int	servlen,
		int	flags
	)

const char* ff_gai_strerror

(

int

ecode

)

int ff_is_multicast_address

(

struct sockaddr *

addr

)

Definition at line 145 of file network.c.

Referenced by ff_udp_set_remote_url().

int ff_listen_bind	(	int	fd,
		const struct sockaddr *	addr,
		socklen_t	addrlen,
		int	timeout,
		URLContext *	h
	)

Bind to a file descriptor and poll for a connection.

Parameters

fd	First argument of bind().
addr	Second argument of bind().
addrlen	Third argument of bind().
timeout	Polling timeout in milliseconds.
h	URLContext providing interrupt check callback and logging context.

Returns

A non-blocking file descriptor on success or an AVERROR on failure.

Definition at line 246 of file network.c.

Referenced by sctp_open(), tcp_open(), and unix_open().

int ff_listen	(	int	fd,
		const struct sockaddr *	addr,
		socklen_t	addrlen
	)

Bind to a file descriptor to an address without accepting connections.

Parameters

fd	First argument of bind().
addr	Second argument of bind().
addrlen	Third argument of bind().

Returns

0 on success or an AVERROR on failure.

Definition at line 210 of file network.c.

Referenced by ff_listen_bind(), and tcp_open().

int ff_accept	(	int	fd,
		int	timeout,
		URLContext *	h
	)

Poll for a single connection on the passed file descriptor.

Parameters

fd	The listening socket file descriptor.
timeout	Polling timeout in milliseconds.
h	URLContext providing interrupt check callback and logging context.

Returns

A non-blocking file descriptor on success or an AVERROR on failure.

Definition at line 228 of file network.c.

Referenced by ff_listen_bind(), and tcp_accept().

int ff_listen_connect	(	int	fd,
		const struct sockaddr *	addr,
		socklen_t	addrlen,
		int	timeout,
		URLContext *	h,
		int	will_try_next
	)

Connect to a file descriptor and poll for result.

Parameters

fd	First argument of connect(), will be set as non-blocking.
addr	Second argument of connect().
addrlen	Third argument of connect().
timeout	Polling timeout in milliseconds.
h	URLContext providing interrupt check callback and logging context.
will_try_next	Whether the caller will try to connect to another address for the same host name, affecting the form of logged errors.

Returns

0 on success, AVERROR on failure.

Definition at line 258 of file network.c.

Referenced by sctp_open(), and unix_open().

int ff_http_match_no_proxy	(	const char *	no_proxy,
		const char *	hostname
	)

Definition at line 551 of file network.c.

Referenced by ff_tls_open_underlying(), http_open_cnx_internal(), and test().

int ff_socket	(	int	domain,
		int	type,
		int	protocol
	)

Definition at line 183 of file network.c.

Referenced by sctp_open(), start_connect_attempt(), tcp_open(), udp_socket_create(), and unix_open().

void ff_log_net_error	(	void *	ctx,
		int	level,
		const char *	prefix
	)

Definition at line 581 of file network.c.

Referenced by customize_fd(), ff_udp_set_remote_url(), udp_join_multicast_group(), udp_leave_multicast_group(), udp_open(), udp_set_multicast_sources(), udp_set_multicast_ttl(), and udp_socket_create().

int ff_connect_parallel	(	struct addrinfo *	addrs,
		int	timeout_ms_per_address,
		int	parallel,
		URLContext *	h,
		int *	fd,
		void(*)(void *, int)	customize_fd,
		void *	customize_ctx
	)

Connect to any of the given addrinfo addresses, with multiple attempts running in parallel.

Parameters

addrs	The list of addresses to try to connect to. This list will be mutated internally, but the list head will remain as such, so this doesn't affect the caller freeing the list afterwards.
timeout_ms_per_address	The number of milliseconds to wait for each connection attempt. Since multiple addresses are tried, some of them in parallel, the total run time will at most be timeout_ms_per_address*ceil(nb_addrs/parallel) + (parallel - 1) * NEXT_ATTEMPT_DELAY_MS.
parallel	The maximum number of connections to attempt in parallel. This is limited to an internal maximum capacity.
h	URLContext providing interrupt check callback and logging context.
fd	If successful, the connected socket is returned here.
customize_fd	Function that will be called for each socket created, to allow the caller to set socket options before calling connect() on it, may be NULL.
customize_ctx	Context parameter passed to customize_fd.

Returns

0 on success, AVERROR on failure.

Definition at line 403 of file network.c.

Referenced by tcp_open().