VLC 4.0.0-dev
Loading...
Searching...
No Matches
vlc_network.h
Go to the documentation of this file.
1/*****************************************************************************
2 * vlc_network.h: interface to communicate with network plug-ins
3 *****************************************************************************
4 * Copyright (C) 2002-2005 VLC authors and VideoLAN
5 * Copyright © 2006-2007 Rémi Denis-Courmont
6 *
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Rémi Denis-Courmont
10 *
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
25
26#ifndef VLC_NETWORK_H
27# define VLC_NETWORK_H
28
29/**
30 * \ingroup os
31 * \defgroup net Networking
32 * @{
33 * \file
34 * Definitions for sockets and low-level networking
35 * \defgroup sockets Internet sockets
36 * @{
37 */
38
39#include <sys/types.h>
40#include <unistd.h>
41
42#if defined( _WIN32 )
43# define _NO_OLDNAMES 1
44# include <winsock2.h>
45# include <ws2tcpip.h>
46# define net_errno (WSAGetLastError())
47# define net_Close(fd) ((void)closesocket((SOCKET)fd))
48# ifndef IPV6_V6ONLY
49# define IPV6_V6ONLY 27
50# endif
51# if !defined(SHUT_RDWR)
52# define SHUT_RDWR (SD_BOTH)
53# define SHUT_WR (SD_SEND)
54# define SHUT_RD (SD_RECEIVE)
55# endif
56#else
57# include <sys/socket.h>
58# include <netinet/in.h>
59# include <netdb.h>
60# define net_errno errno
61# define net_Close(fd) ((void)vlc_close(fd))
62#endif
63
64/**
65 * Creates a socket file descriptor.
66 *
67 * This function creates a socket, similar to the standard socket() function.
68 * However, the new file descriptor has the close-on-exec flag set atomically,
69 * so as to avoid leaking the descriptor to child processes.
70 *
71 * The non-blocking flag can also optionally be set.
72 *
73 * @param pf protocol family
74 * @param type socket type
75 * @param proto network protocol
76 * @param nonblock true to create a non-blocking socket
77 * @return a new file descriptor or -1 on error
78 */
79VLC_API int vlc_socket(int pf, int type, int proto, bool nonblock) VLC_USED;
80
81/**
82 * Creates a pair of socket file descriptors.
83 *
84 * This function creates a pair of sockets that are mutually connected,
85 * much like the standard socketpair() function. However, the new file
86 * descriptors have the close-on-exec flag set atomically.
87 * See also vlc_socket().
88 *
89 * @param pf protocol family
90 * @param type socket type
91 * @param proto network protocol
92 * @param fds the output array storing the file descriptor pair
93 * @param nonblock true to create non-blocking sockets
94 * @retval 0 on success
95 * @retval -1 on failure
96 */
97VLC_API int vlc_socketpair(int pf, int type, int proto, int fds[2],
98 bool nonblock);
99
100struct sockaddr;
101
102/**
103 * Accepts an inbound connection request on a listening socket.
104 *
105 * This function creates a connected socket from a listening socket, much like
106 * the standard accept() function. However, the new file descriptor has the
107 * close-on-exec flag set atomically. See also vlc_socket().
108 *
109 * @param lfd listening socket file descriptor
110 * @param addr pointer to the peer address or NULL [OUT]
111 * @param alen pointer to the length of the peer address or NULL [OUT]
112 * @param nonblock whether to put the new socket in non-blocking mode
113 * @return a new file descriptor or -1 on error
114 */
115VLC_API int vlc_accept(int lfd, struct sockaddr *addr, socklen_t *alen,
116 bool nonblock) VLC_USED;
117
118/**
119 * Sends data.
120 *
121 * Like @c send(), this function sends raw data to the peer of a
122 * connection-mode socket, or to the predefined peer of a connection-less
123 * socket.
124 * Unlike @c send(), this function never triggers a signal; if the peer hung
125 * up, it returns an error.
126 *
127 * @param fd socket to send data through
128 * @param buf start address of data
129 * @param buflen byte size of data
130 * @param flags socket send flags (see @c send() documentation)
131 * @return number of bytes actually sent, or -1 on error (@c errno is set)
132 */
133VLC_API ssize_t vlc_send(int fd, const void *buf, size_t buflen, int flags);
134
135/**
136 * Sends data to a peer.
137 *
138 * This function operates like @c sendto() with the exception that it never
139 * triggers a signal.
140 *
141 * This function mainly exists for the sakes of completeness and consistency:
142 * - To send data on a connection-mode socket, using \ref vlc_send() is
143 * simpler.
144 * - To send data on a connection-less socket, @c sendto() and/or @c send() can
145 * be used directly.
146 *
147 * @param fd socket to send data through
148 * @param buf start address of data
149 * @param buflen byte size of data
150 * @param flags socket send flags (see @c send() documentation)
151 * @param dst destination address (ignored for connection-mode sockets)
152 * @param dstlen byte size of destination address
153 * @return number of bytes actually sent, or -1 on error (@c errno is set)
154 */
155VLC_API ssize_t vlc_sendto(int fd, const void *buf, size_t buflen, int flags,
156 const struct sockaddr *dst, socklen_t dstlen);
157
158/**
159 * Sends a socket message.
160 *
161 * Like @c sendmsg(), this function sends a message through a socket.
162 * Unlike @c sendmsg(), this function never triggers a signal; if the peer hung
163 * up, it returns an error.
164 *
165 * @param fd socket to send data through
166 * @param msg message to send (see @c sendmsg() documentation)
167 * @param flags socket send flags (see @c sendmsg() documentation)
168 * @return number of bytes actually sent, or -1 on error (@c errno is set)
169 */
170VLC_API ssize_t vlc_sendmsg(int fd, const struct msghdr *msg, int flags);
171
172# ifdef __cplusplus
173extern "C" {
174# endif
175
176/* Portable networking layer communication */
177int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
178
179VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
180#define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
182VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, unsigned i_port, int socktype, int protocol);
183
184#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
185 SOCK_STREAM, IPPROTO_TCP)
186
187VLC_API int net_ConnectTCP (vlc_object_t *obj, const char *host, int port);
188#define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
190/**
191 * Accepts an new connection on a set of listening sockets.
192 *
193 * If there are no pending connections, this function will wait.
194 *
195 * @note If the thread needs to handle events other than incoming connections,
196 * you need to use poll() and net_AcceptSingle() instead.
197 *
198 * @deprecated This function exists for backward compatibility.
199 * Use vlc_accept() or vlc_accept_i11e() in new code.
200 *
201 * @param obj VLC object for logging and object kill signal
202 * @param fds listening socket set
203 * @return -1 on error (may be transient error due to network issues),
204 * a new socket descriptor on success.
205 */
206VLC_API int net_Accept(vlc_object_t *obj, int *fds);
207#define net_Accept(a, b) \
208 net_Accept(VLC_OBJECT(a), b)
209
210VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, unsigned i_port, int hlim, int proto );
211#define net_ConnectDgram(a, b, c, d, e ) \
212 net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
213
214static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, unsigned port, int hlim)
216 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
217}
218
219VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, unsigned i_bind, const char *psz_server, unsigned i_server, int proto );
220#define net_OpenDgram( a, b, c, d, e, g ) \
221 net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
222
223static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, unsigned port)
225 return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
226}
227
228VLC_API void net_ListenClose( int *fd );
229
230VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
231
232/**
233 * Reads data from a socket.
234 *
235 * This blocks until all requested data is received
236 * or the end of the stream is reached.
237 *
238 * This function is a cancellation point.
239 * @return -1 on error, or the number of bytes of read.
240 */
241VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, void *p_data, size_t i_data );
242#define net_Read(a,b,c,d) net_Read(VLC_OBJECT(a),b,c,d)
244/**
245 * Writes data to a socket.
246 *
247 * This blocks until all data is written or an error occurs.
248 *
249 * This function is a cancellation point.
250 *
251 * @return the total number of bytes written, or -1 if an error occurs
252 * before any data is written.
253 */
254VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const void *p_data, size_t i_data );
255#define net_Write(a,b,c,d) net_Write(VLC_OBJECT(a),b,c,d)
257VLC_API int vlc_close(int);
258
259/** @} */
260
261#ifdef _WIN32
262static inline int vlc_getsockopt(int s, int level, int name,
263 void *val, socklen_t *len)
264{
265 return getsockopt(s, level, name, (char *)val, len);
266}
267#define getsockopt vlc_getsockopt
268
269static inline int vlc_setsockopt(int s, int level, int name,
270 const void *val, socklen_t len)
271{
272 return setsockopt(s, level, name, (const char *)val, len);
273}
274#define setsockopt vlc_setsockopt
275#endif
276
277/* Portable network names/addresses resolution layer */
278
279#define NI_MAXNUMERICHOST 64
281#ifndef AI_NUMERICSERV
282# define AI_NUMERICSERV 0
283#endif
284#ifndef AI_IDN
285# define AI_IDN 0 /* GNU/libc extension */
286#endif
287
288#ifdef _WIN32
289# if defined(UNICODE)
290# undef gai_strerror
291# define gai_strerror gai_strerrorA
292# endif
293#endif
294
295VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
296
297/**
298 * Resolves a host name to a list of socket addresses (like getaddrinfo()).
299 *
300 * @param node host name to resolve (encoded as UTF-8), or NULL
301 * @param i_port port number for the socket addresses
302 * @param p_hints parameters (see getaddrinfo() manual page)
303 * @param res pointer set to the resulting chained list.
304 * @return 0 on success, a getaddrinfo() error otherwise.
305 * On failure, *res is undefined. On success, it must be freed with
306 * freeaddrinfo().
307 */
308VLC_API int vlc_getaddrinfo (const char *node, unsigned i_port,
309 const struct addrinfo *p_hints,
310 struct addrinfo **res);
311VLC_API int vlc_getaddrinfo_i11e(const char *, unsigned,
312 const struct addrinfo *, struct addrinfo **);
313
314static inline bool
315net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
317 switch (addr->sa_family)
318 {
319#ifdef IN_MULTICAST
320 case AF_INET:
321 {
322 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
323 if ((size_t)len < sizeof (*v4))
324 return false;
325 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
326 }
327#endif
328
329#ifdef IN6_IS_ADDR_MULTICAST
330 case AF_INET6:
331 {
332 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
333 if ((size_t)len < sizeof (*v6))
334 return false;
335 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
336 }
337#endif
338 }
339
340 return false;
341}
342
343
344static inline int net_GetSockAddress( int fd, char *address, int *port )
346 struct sockaddr_storage addr;
347 socklen_t addrlen = sizeof( addr );
348
349 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
350 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
351 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
352 ? VLC_EGENERIC : 0;
353}
354
355static inline int net_GetPeerAddress( int fd, char *address, int *port )
357 struct sockaddr_storage addr;
358 socklen_t addrlen = sizeof( addr );
359
360 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
361 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
362 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
363 ? VLC_EGENERIC : 0;
364}
365
366/**
367 * Determines the network proxy server to use (if any).
368 * @param url absolute URL for which to get the proxy server
369 * @return proxy URL, NULL if no proxy or error
370 */
371VLC_API char *vlc_getProxyUrl(const char *);
372
373# ifdef __cplusplus
374}
375# endif
376
377/** @} */
378
379#endif
#define VLC_USED
Definition fourcc_gen.c:32
#define VLC_API
Definition fourcc_gen.c:31
#define VLC_EGENERIC
Unspecified error.
Definition vlc_common.h:480
static bool net_SockAddrIsMulticast(const struct sockaddr *addr, socklen_t len)
Definition vlc_network.h:316
static int net_GetPeerAddress(int fd, char *address, int *port)
Definition vlc_network.h:356
int vlc_getaddrinfo(const char *node, unsigned i_port, const struct addrinfo *p_hints, struct addrinfo **res)
Resolves a host name to a list of socket addresses (like getaddrinfo()).
Definition getaddrinfo.c:65
char * vlc_getProxyUrl(const char *)
Determines the network proxy server to use (if any).
Definition specific.c:334
#define NI_MAXNUMERICHOST
Definition vlc_network.h:280
int vlc_getaddrinfo_i11e(const char *, unsigned, const struct addrinfo *, struct addrinfo **)
Definition getaddrinfo.c:39
static int net_GetSockAddress(int fd, char *address, int *port)
Definition vlc_network.h:345
int vlc_getnameinfo(const struct sockaddr *, int, char *, int, int *, int)
Definition getaddrinfo.c:39
#define net_OpenDgram(a, b, c, d, e, g)
Definition vlc_network.h:221
static int net_ListenUDP1(vlc_object_t *obj, const char *host, unsigned port)
Definition vlc_network.h:224
#define net_Write(a, b, c, d)
Definition vlc_network.h:256
ssize_t vlc_sendmsg(int fd, const struct msghdr *msg, int flags)
Sends a socket message.
Definition filesystem.c:384
#define net_Accept(a, b)
Definition vlc_network.h:208
ssize_t vlc_sendto(int fd, const void *buf, size_t buflen, int flags, const struct sockaddr *dst, socklen_t dstlen)
Sends data to a peer.
Definition filesystem.c:378
ssize_t vlc_send(int fd, const void *buf, size_t buflen, int flags)
Sends data.
Definition filesystem.c:373
static int net_ConnectUDP(vlc_object_t *obj, const char *host, unsigned port, int hlim)
Definition vlc_network.h:215
int vlc_socket(int pf, int type, int proto, bool nonblock)
Creates a socket file descriptor.
Definition filesystem.c:337
#define net_Read(a, b, c, d)
Definition vlc_network.h:243
int * net_Listen(vlc_object_t *p_this, const char *psz_host, unsigned i_port, int socktype, int protocol)
Definition io.c:209
int vlc_accept(int lfd, struct sockaddr *addr, socklen_t *alen, bool nonblock)
Accepts an inbound connection request on a listening socket.
Definition filesystem.c:355
int vlc_close(int)
Closes a file descriptor.
Definition filesystem.c:91
#define net_Connect(a, b, c, d, e)
Definition vlc_network.h:181
void net_ListenClose(int *fd)
Definition io.c:291
int net_SetCSCov(int fd, int sendcov, int recvcov)
net_SetCSCov: Sets the send and receive checksum coverage of a socket:
Definition udp.c:717
int vlc_socketpair(int pf, int type, int proto, int fds[2], bool nonblock)
Creates a pair of socket file descriptors.
Definition filesystem.c:345
#define net_ConnectDgram(a, b, c, d, e)
Definition vlc_network.h:212
#define net_ConnectTCP(a, b, c)
Definition vlc_network.h:189
int net_Socket(vlc_object_t *obj, int family, int socktype, int proto)
Definition io.c:66
const char name[16]
Definition httpd.c:1298
uint16_t i_port
Definition keystore.c:217
VLC object common members.
Definition vlc_objects.h:53
This file is a collection of common definitions and types.