1 /*****************************************************************************
2 * vlc_network.h: interface to communicate with network plug-ins
3 *****************************************************************************
4 * Copyright (C) 2002-2005 the VideoLAN team
5 * Copyright © 2006-2007 Rémi Denis-Courmont
8 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * Laurent Aimar <fenrir@via.ecp.fr>
10 * Rémi Denis-Courmont <rem # videolan.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 #if !defined( __LIBVLC__ )
28 #error You are not libvlc or one of its plugins. You cannot include this file
31 #ifndef __VLC_NETWORK_H
32 # define __VLC_NETWORK_H
35 # if defined(UNDER_CE) && defined(sockaddr_storage)
36 # undef sockaddr_storage
38 # if defined(UNDER_CE)
39 # define HAVE_STRUCT_ADDRINFO
41 # define _NO_OLDNAMES 1
44 # include <winsock2.h>
45 # include <ws2tcpip.h>
46 # define ENETUNREACH WSAENETUNREACH
47 # define net_errno (WSAGetLastError())
48 extern const char *net_strerror( int val );
50 # define IPV6_V6ONLY 27
53 # if HAVE_SYS_SOCKET_H
54 # include <sys/socket.h>
56 # if HAVE_NETINET_IN_H
57 # include <netinet/in.h>
60 # include <arpa/inet.h>
61 # elif defined( SYS_BEOS )
62 # include <net/netdb.h>
65 # define net_errno errno
72 /* Portable networking layer communication */
73 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
74 int net_SetupSocket (int fd);
76 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
77 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
79 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
81 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
82 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
84 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
86 return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
89 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
90 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
92 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
93 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
95 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
97 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
100 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
101 VLC_EXPORT( int, __net_OpenDgram, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int family, int proto ) );
103 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
105 return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
108 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
110 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
113 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
115 /* Functions to read from or write to the networking layer */
116 struct virtual_socket_t
119 int (*pf_recv) ( void *, void *, int );
120 int (*pf_send) ( void *, const void *, int );
123 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
124 VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data, vlc_bool_t b_retry ) );
126 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
127 VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, size_t i_data ) );
129 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
130 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
132 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
134 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
135 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
138 #ifndef HAVE_INET_PTON
139 /* only in core, so no need for C++ extern "C" */
140 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
143 #ifndef HAVE_INET_NTOP
145 /* only in core, so no need for C++ extern "C" */
146 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
147 char *dst, socklen_t cnt) );
157 POLLERR=8, // unsupported stub
158 POLLHUP=16, // unsupported stub
159 POLLNVAL=32 // unsupported stub
169 VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
173 /* Microsoft: same semantic, same value, different name... go figure */
174 # define SHUT_RD SD_RECEIVE
175 # define SHUT_WR SD_SEND
176 # define SHUT_RDWR SD_BOTH
177 # define net_Close( fd ) closesocket ((SOCKET)fd)
182 # define net_Close( fd ) (void)close (fd)
185 /* Portable network names/addresses resolution layer */
187 /* GAI error codes */
188 # ifndef EAI_BADFLAGS
189 # define EAI_BADFLAGS -1
192 # define EAI_NONAME -2
195 # define EAI_AGAIN -3
201 # define EAI_NODATA -5
204 # define EAI_FAMILY -6
206 # ifndef EAI_SOCKTYPE
207 # define EAI_SOCKTYPE -7
210 # define EAI_SERVICE -8
212 # ifndef EAI_ADDRFAMILY
213 # define EAI_ADDRFAMILY -9
216 # define EAI_MEMORY -10
219 # define EAI_OVERFLOW -11
222 # define EAI_SYSTEM -12
227 # define NI_MAXHOST 1025
228 # define NI_MAXSERV 32
230 # define NI_MAXNUMERICHOST 64
232 # ifndef NI_NUMERICHOST
233 # define NI_NUMERICHOST 0x01
234 # define NI_NUMERICSERV 0x02
235 # define NI_NOFQDN 0x04
236 # define NI_NAMEREQD 0x08
237 # define NI_DGRAM 0x10
240 # ifndef HAVE_STRUCT_ADDRINFO
248 struct sockaddr *ai_addr;
250 struct addrinfo *ai_next;
252 # define AI_PASSIVE 1
253 # define AI_CANONNAME 2
254 # define AI_NUMERICHOST 4
255 # endif /* if !HAVE_STRUCT_ADDRINFO */
257 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
258 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
259 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
260 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
263 static inline vlc_bool_t
264 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
266 switch (addr->sa_family)
271 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
272 if ((size_t)len < sizeof (*v4))
274 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
278 #ifdef IN6_IS_ADDR_MULTICAST
281 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
282 if ((size_t)len < sizeof (*v6))
284 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
295 * net_AddressIsMulticast
296 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
297 * or the address is not a valid address.
299 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
301 struct addrinfo hints, *res;
303 memset (&hints, 0, sizeof (hints));
304 hints.ai_socktype = SOCK_DGRAM; /* UDP */
305 hints.ai_flags = AI_NUMERICHOST;
307 int i = vlc_getaddrinfo (p_object, psz_addr, 0,
311 msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
312 psz_addr, vlc_gai_strerror (i));
316 vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
317 vlc_freeaddrinfo (res);
321 static inline int net_GetSockAddress( int fd, char *address, int *port )
323 struct sockaddr_storage addr;
324 socklen_t addrlen = sizeof( addr );
326 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
327 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
328 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
332 static inline int net_GetPeerAddress( int fd, char *address, int *port )
334 struct sockaddr_storage addr;
335 socklen_t addrlen = sizeof( addr );
337 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
338 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
339 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
343 static inline uint16_t net_GetPort (const struct sockaddr *addr)
345 switch (addr->sa_family)
349 return ((const struct sockaddr_in6 *)addr)->sin6_port;
352 return ((const struct sockaddr_in *)addr)->sin_port;
357 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
359 switch (addr->sa_family)
363 ((struct sockaddr_in6 *)addr)->sin6_port = port;
367 ((struct sockaddr_in *)addr)->sin_port = port;