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 # if HAVE_SYS_SOCKET_H
51 # include <sys/socket.h>
53 # if HAVE_NETINET_IN_H
54 # include <netinet/in.h>
57 # include <arpa/inet.h>
58 # elif defined( SYS_BEOS )
59 # include <net/netdb.h>
62 # define net_errno errno
63 # define net_strerror strerror
70 /* Portable networking layer communication */
71 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
73 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
75 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port,
76 int family, int socktype, int protocol) );
77 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
79 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
80 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
82 static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
84 return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
87 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
89 return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
92 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
93 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
95 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
96 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
98 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
100 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
103 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
105 return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
108 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
109 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 ) );
111 VLC_EXPORT( void, net_Close, ( int fd ) );
112 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
114 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
115 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
118 /* Functions to read from or write to the networking layer */
119 struct virtual_socket_t
122 int (*pf_recv) ( void *, void *, int );
123 int (*pf_send) ( void *, const void *, int );
126 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
127 VLC_EXPORT( int, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, vlc_bool_t b_retry ) );
129 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
130 VLC_EXPORT( int, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, mtime_t i_wait ) );
132 #define net_Select(a,b,c,d,e,f) __net_Select(VLC_OBJECT(a),b,c,d,e,f)
133 VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
135 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
136 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
138 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
139 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
141 VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
143 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
144 VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
147 #ifndef HAVE_INET_PTON
148 /* only in core, so no need for C++ extern "C" */
149 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
158 POLLERR=8, // unsupported stub
159 POLLHUP=16, // unsupported stub
160 POLLNVAL=32 // unsupported stub
170 int poll (struct pollfd *fds, unsigned nfds, int timeout);
174 /*****************************************************************************
176 *****************************************************************************
177 * Wrappers for shutdown()
178 *****************************************************************************/
179 #if defined (SHUT_WR)
180 /* the standard way */
181 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
182 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
183 #elif defined (SD_SEND)
184 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
185 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
186 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
188 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
189 # warning FIXME: implement shutdown on your platform!
191 # define net_StopSend( fd ) (void)0
192 # define net_StopRecv( fd ) (void)0
195 /* Portable network names/addresses resolution layer */
197 /* GAI error codes */
198 # ifndef EAI_BADFLAGS
199 # define EAI_BADFLAGS -1
202 # define EAI_NONAME -2
205 # define EAI_AGAIN -3
211 # define EAI_NODATA -5
214 # define EAI_FAMILY -6
216 # ifndef EAI_SOCKTYPE
217 # define EAI_SOCKTYPE -7
220 # define EAI_SERVICE -8
222 # ifndef EAI_ADDRFAMILY
223 # define EAI_ADDRFAMILY -9
226 # define EAI_MEMORY -10
229 # define EAI_SYSTEM -11
234 # define NI_MAXHOST 1025
235 # define NI_MAXSERV 32
237 # define NI_MAXNUMERICHOST 64
239 # ifndef NI_NUMERICHOST
240 # define NI_NUMERICHOST 0x01
241 # define NI_NUMERICSERV 0x02
242 # define NI_NOFQDN 0x04
243 # define NI_NAMEREQD 0x08
244 # define NI_DGRAM 0x10
247 # ifndef HAVE_STRUCT_ADDRINFO
255 struct sockaddr *ai_addr;
257 struct addrinfo *ai_next;
259 # define AI_PASSIVE 1
260 # define AI_CANONNAME 2
261 # define AI_NUMERICHOST 4
262 # endif /* if !HAVE_STRUCT_ADDRINFO */
264 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
265 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
266 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
267 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
270 static inline vlc_bool_t
271 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
273 switch (addr->sa_family)
278 struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
279 if ((size_t)len < sizeof (*v4))
281 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
285 #ifdef IN6_IS_ADDR_MULTICAST
288 struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
289 if ((size_t)len < sizeof (*v6))
291 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
302 * net_AddressIsMulticast
303 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
304 * or the address is not a valid address.
306 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
308 struct addrinfo hints, *res;
310 memset (&hints, 0, sizeof (hints));
311 hints.ai_socktype = SOCK_DGRAM; /* UDP */
312 hints.ai_flags = AI_NUMERICHOST;
314 int i = vlc_getaddrinfo (p_object, psz_addr, 0,
318 msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
319 psz_addr, vlc_gai_strerror (i));
323 vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
324 vlc_freeaddrinfo (res);
328 static inline int net_GetSockAddress( int fd, char *address, int *port )
330 struct sockaddr_storage addr;
331 socklen_t addrlen = sizeof( addr );
333 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
334 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
335 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
339 static inline int net_GetPeerAddress( int fd, char *address, int *port )
341 struct sockaddr_storage addr;
342 socklen_t addrlen = sizeof( addr );
344 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
345 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
346 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
350 static inline uint16_t net_GetPort (const struct sockaddr *addr)
352 switch (addr->sa_family)
356 return ((const struct sockaddr_in6 *)addr)->sin6_port;
359 return ((const struct sockaddr_in *)addr)->sin_port;
364 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
366 switch (addr->sa_family)
370 ((struct sockaddr_in6 *)addr)->sin6_port = port;
374 ((struct sockaddr_in *)addr)->sin_port = port;