FFmpeg
Loading...
Searching...
No Matches
network.h File Reference
#include <errno.h>
#include <stdatomic.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  FFNetWakeup
 A channel for waking a thread that is blocked in ff_network_wait_fd_wakeup(), from another thread. More...
 
struct  sockaddr_storage
 
union  sockaddr_union
 
struct  addrinfo
 

Macros

#define ff_neterrno()
 
#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)
 
#define IN6_IS_ADDR_MULTICAST(a)
 
#define POLLING_TIME   100
 

Functions

int ff_socket_nonblock (int socket, int enable)
 
int ff_network_init (void)
 Initialize the network subsystem.
 
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.
 
int ff_network_sleep_interruptible (int64_t timeout, AVIOInterruptCB *int_cb)
 Waits for up to 'timeout' microseconds.
 
int ff_network_wakeup_open (FFNetWakeup *w)
 Create a wakeup channel.
 
int ff_network_wakeup_signal (FFNetWakeup *w)
 Wake the thread blocked in ff_network_wait_fd_wakeup() on this channel, or the next one that waits on it: the signal is not consumed, so a signal sent before the wait starts is not lost.
 
void ff_network_wakeup_close (FFNetWakeup *w)
 Close the channel.
 
int ff_network_wait_fd_wakeup (int fd, int write, int timeout_ms, const FFNetWakeup *w)
 Like ff_network_wait_fd(), but also returns as soon as the wakeup channel is signaled, and with a caller chosen timeout.
 
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.
 
int ff_listen (int fd, const struct sockaddr *addr, socklen_t addrlen, void *logctx)
 Bind to a file descriptor to an address without accepting connections.
 
int ff_accept (int fd, int timeout, URLContext *h)
 Poll for a single connection on the passed file descriptor.
 
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.
 
int ff_http_match_no_proxy (const char *no_proxy, const char *hostname)
 
int ff_socket (int domain, int type, int protocol, void *logctx)
 
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, int(*customize_fd)(void *, int, int), void *customize_ctx)
 Connect to any of the given addrinfo addresses, with multiple attempts running in parallel.
 
void ff_udp_get_last_recv_addr (URLContext *h, struct sockaddr_storage *addr, socklen_t *addr_len)
 
int ff_udp_set_remote_addr (URLContext *h, const struct sockaddr *dest_addr, socklen_t dest_addr_len, int do_connect)
 This function is identical to ff_udp_set_remote_url, except that it takes a sockaddr directly.
 

Macro Definition Documentation

◆ ff_neterrno

◆ MSG_NOSIGNAL

#define MSG_NOSIGNAL   0

Definition at line 196 of file network.h.

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

◆ EAI_AGAIN

#define EAI_AGAIN   2

Definition at line 214 of file network.h.

◆ EAI_BADFLAGS

#define EAI_BADFLAGS   3

Definition at line 217 of file network.h.

◆ EAI_FAIL

#define EAI_FAIL   4

Definition at line 220 of file network.h.

◆ EAI_FAMILY

#define EAI_FAMILY   5

Definition at line 223 of file network.h.

◆ EAI_MEMORY

#define EAI_MEMORY   6

Definition at line 226 of file network.h.

◆ EAI_NODATA

#define EAI_NODATA   7

Definition at line 229 of file network.h.

◆ EAI_NONAME

#define EAI_NONAME   8

Definition at line 232 of file network.h.

◆ EAI_SERVICE

#define EAI_SERVICE   9

Definition at line 235 of file network.h.

◆ EAI_SOCKTYPE

#define EAI_SOCKTYPE   10

Definition at line 238 of file network.h.

◆ AI_PASSIVE

#define AI_PASSIVE   1

Definition at line 242 of file network.h.

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

◆ AI_CANONNAME

#define AI_CANONNAME   2

Definition at line 246 of file network.h.

◆ AI_NUMERICHOST

#define AI_NUMERICHOST   4

Definition at line 250 of file network.h.

Referenced by ff_tls_parse_host(), ff_url_join(), get_sockaddr(), and tls_open().

◆ NI_NOFQDN

#define NI_NOFQDN   1

Definition at line 254 of file network.h.

◆ NI_NUMERICHOST

#define NI_NUMERICHOST   2

Definition at line 258 of file network.h.

Referenced by ff_connect_parallel(), and print_address_list().

◆ NI_NAMERQD

#define NI_NAMERQD   4

Definition at line 262 of file network.h.

◆ NI_NUMERICSERV

#define NI_NUMERICSERV   8

Definition at line 266 of file network.h.

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

◆ NI_DGRAM

#define NI_DGRAM   16

Definition at line 270 of file network.h.

◆ getaddrinfo

◆ freeaddrinfo

◆ getnameinfo

#define getnameinfo   ff_getnameinfo

Definition at line 282 of file network.h.

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

◆ gai_strerror

#define gai_strerror   ff_gai_strerror

◆ INADDR_LOOPBACK

#define INADDR_LOOPBACK   0x7f000001

Definition at line 292 of file network.h.

Referenced by ff_network_wakeup_open().

◆ INET_ADDRSTRLEN

#define INET_ADDRSTRLEN   16

Definition at line 296 of file network.h.

◆ INET6_ADDRSTRLEN

#define INET6_ADDRSTRLEN   INET_ADDRSTRLEN

Definition at line 300 of file network.h.

◆ IN_MULTICAST

#define IN_MULTICAST ( a)
Value:
((((uint32_t)(a)) & 0xf0000000) == 0xe0000000)
int a

Definition at line 304 of file network.h.

Referenced by ff_is_multicast_address().

◆ IN6_IS_ADDR_MULTICAST

#define IN6_IS_ADDR_MULTICAST ( a)
Value:
(((uint8_t *) (a))[0] == 0xff)

Definition at line 307 of file network.h.

Referenced by ff_is_multicast_address().

◆ POLLING_TIME

Function Documentation

◆ ff_socket_nonblock()

int ff_socket_nonblock ( int socket,
int enable )

◆ ff_network_init()

int ff_network_init ( void )

Initialize the network subsystem.

On Windows, this calls WSAStartup().

Returns
0 on success, a negative AVERROR code on failure.

Definition at line 66 of file network.c.

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

◆ ff_network_close()

◆ ff_tls_init()

int ff_tls_init ( void )

Definition at line 42 of file network.c.

Referenced by avformat_network_init().

◆ ff_tls_deinit()

void ff_tls_deinit ( void )

Definition at line 52 of file network.c.

Referenced by avformat_network_deinit().

◆ ff_network_wait_fd()

int ff_network_wait_fd ( int fd,
int write )

◆ ff_network_wait_fd_timeout()

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
fdSocket descriptor
writeSet 1 to wait for socket able to be read, 0 to be written
timeoutTimeout interval, in microseconds. Actual precision is 100000 mcs, due to ff_network_wait_fd usage
int_cbInterrupt 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 86 of file network.c.

Referenced by amqp_proto_read(), amqp_proto_write(), tcp_read(), and tcp_write().

◆ ff_network_sleep_interruptible()

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
timeoutTimeout in microseconds. Maybe have lower actual precision.
int_cbInterrupt callback, is checked regularly.
Returns
AVERROR(ETIMEDOUT) if timeout expirted, AVERROR_EXIT if interrupted by int_cb

Definition at line 221 of file network.c.

Referenced by http_open_cnx(), and http_read_stream().

◆ ff_network_wakeup_open()

int ff_network_wakeup_open ( FFNetWakeup * w)

Create a wakeup channel.

On Windows ff_network_init() must have been called first.

Returns
0 on success, a negative AVERROR code on failure

Definition at line 106 of file network.c.

Referenced by udp_open().

◆ ff_network_wakeup_signal()

int ff_network_wakeup_signal ( FFNetWakeup * w)

Wake the thread blocked in ff_network_wait_fd_wakeup() on this channel, or the next one that waits on it: the signal is not consumed, so a signal sent before the wait starts is not lost.

Only the first call has an effect; the function may be called any number of times, from any thread.

Returns
0 on success, a negative AVERROR code if the first call failed to write to the channel

Definition at line 162 of file network.c.

Referenced by udp_close().

◆ ff_network_wakeup_close()

void ff_network_wakeup_close ( FFNetWakeup * w)

Close the channel.

Call it after the waiting thread has been joined and no thread can signal any more.

Definition at line 185 of file network.c.

Referenced by udp_close(), and udp_open().

◆ ff_network_wait_fd_wakeup()

int ff_network_wait_fd_wakeup ( int fd,
int write,
int timeout_ms,
const FFNetWakeup * w )

Like ff_network_wait_fd(), but also returns as soon as the wakeup channel is signaled, and with a caller chosen timeout.

Parameters
fdSocket descriptor
writeSet 1 to wait for the socket to be writable, 0 for readable
timeout_msTimeout in milliseconds, or -1 to wait indefinitely
wWakeup channel to watch, must have been opened
Returns
0 if fd is ready, AVERROR(EAGAIN) if the timeout expired, AVERROR_EXIT if w was signaled (also when fd is ready), or a negative error code

Definition at line 194 of file network.c.

◆ ff_getaddrinfo()

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

◆ ff_freeaddrinfo()

void ff_freeaddrinfo ( struct addrinfo * res)

◆ ff_getnameinfo()

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

◆ ff_gai_strerror()

const char * ff_gai_strerror ( int ecode)

◆ ff_is_multicast_address()

int ff_is_multicast_address ( struct sockaddr * addr)

Definition at line 268 of file network.c.

Referenced by ff_udp_set_remote_addr(), and ff_udp_set_remote_url().

◆ ff_listen_bind()

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
fdFirst argument of bind().
addrSecond argument of bind().
addrlenThird argument of bind().
timeoutPolling timeout in milliseconds.
hURLContext providing interrupt check callback and logging context.
Returns
A non-blocking file descriptor on success or an AVERROR on failure.

Definition at line 369 of file network.c.

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

◆ ff_listen()

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

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

Parameters
fdFirst argument of bind().
addrSecond argument of bind().
addrlenThird argument of bind().
Returns
0 on success or an AVERROR on failure.

Definition at line 333 of file network.c.

Referenced by ff_listen_bind(), and tcp_open().

◆ ff_accept()

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

Poll for a single connection on the passed file descriptor.

Parameters
fdThe listening socket file descriptor.
timeoutPolling timeout in milliseconds.
hURLContext providing interrupt check callback and logging context.
Returns
A non-blocking file descriptor on success or an AVERROR on failure.

Definition at line 351 of file network.c.

Referenced by ff_listen_bind(), and tcp_accept().

◆ ff_listen_connect()

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
fdFirst argument of connect(), will be set as non-blocking.
addrSecond argument of connect().
addrlenThird argument of connect().
timeoutPolling timeout in milliseconds.
hURLContext providing interrupt check callback and logging context.
will_try_nextWhether 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 381 of file network.c.

Referenced by sctp_open(), and unix_open().

◆ ff_http_match_no_proxy()

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

Definition at line 676 of file network.c.

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

◆ ff_socket()

int ff_socket ( int domain,
int type,
int protocol,
void * logctx )

◆ ff_log_net_error()

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

◆ ff_connect_parallel()

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

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

Parameters
addrsThe 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_addressThe 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.
parallelThe maximum number of connections to attempt in parallel. This is limited to an internal maximum capacity.
hURLContext providing interrupt check callback and logging context.
fdIf successful, the connected socket is returned here.
customize_fdFunction 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_ctxContext parameter passed to customize_fd.
Returns
0 on success, AVERROR on failure.

Definition at line 531 of file network.c.

Referenced by tcp_open().

◆ ff_udp_get_last_recv_addr()

void ff_udp_get_last_recv_addr ( URLContext * h,
struct sockaddr_storage * addr,
socklen_t * addr_len )

Definition at line 510 of file udp.c.

Referenced by gnutls_url_pull(), mbedtls_recv(), tls_handshake_loop(), and url_bio_bread().

◆ ff_udp_set_remote_addr()

int ff_udp_set_remote_addr ( URLContext * h,
const struct sockaddr * dest_addr,
socklen_t dest_addr_len,
int do_connect )

This function is identical to ff_udp_set_remote_url, except that it takes a sockaddr directly.

Definition at line 472 of file udp.c.

Referenced by gnutls_url_pull(), mbedtls_recv(), tls_handshake_loop(), and url_bio_bread().