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 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
74 #define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
75 VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
77 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port,
78 int family, int socktype, int protocol) );
79 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
81 #define net_ListenTCP(a, b, c) __net_ListenTCP(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 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
88 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
90 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
91 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
93 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
95 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
98 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
100 return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
103 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
104 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 ) );
106 VLC_EXPORT( void, net_Close, ( int fd ) );
107 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
109 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
110 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
113 /* Functions to read from or write to the networking layer */
114 struct virtual_socket_t
117 int (*pf_recv) ( void *, void *, int );
118 int (*pf_send) ( void *, const void *, int );
121 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
122 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 ) );
124 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
125 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 ) );
127 #define net_Select(a,b,c,d,e,f) __net_Select(VLC_OBJECT(a),b,c,d,e,f)
128 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 ) );
130 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
131 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
133 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
134 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
136 VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
138 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
139 VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
142 #ifndef HAVE_INET_PTON
143 /* only in core, so no need for C++ extern "C" */
144 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
153 POLLERR=8, // unsupported stub
154 POLLHUP=16, // unsupported stub
155 POLLNVAL=32 // unsupported stub
165 int poll (struct pollfd *fds, unsigned nfds, int timeout);
169 /*****************************************************************************
171 *****************************************************************************
172 * Wrappers for shutdown()
173 *****************************************************************************/
174 #if defined (SHUT_WR)
175 /* the standard way */
176 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
177 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
178 #elif defined (SD_SEND)
179 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
180 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
181 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
183 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
184 # warning FIXME: implement shutdown on your platform!
186 # define net_StopSend( fd ) (void)0
187 # define net_StopRecv( fd ) (void)0
190 /* Portable network names/addresses resolution layer */
192 /* GAI error codes */
193 # ifndef EAI_BADFLAGS
194 # define EAI_BADFLAGS -1
197 # define EAI_NONAME -2
200 # define EAI_AGAIN -3
206 # define EAI_NODATA -5
209 # define EAI_FAMILY -6
211 # ifndef EAI_SOCKTYPE
212 # define EAI_SOCKTYPE -7
215 # define EAI_SERVICE -8
217 # ifndef EAI_ADDRFAMILY
218 # define EAI_ADDRFAMILY -9
221 # define EAI_MEMORY -10
224 # define EAI_SYSTEM -11
229 # define NI_MAXHOST 1025
230 # define NI_MAXSERV 32
232 # define NI_MAXNUMERICHOST 64
234 # ifndef NI_NUMERICHOST
235 # define NI_NUMERICHOST 0x01
236 # define NI_NUMERICSERV 0x02
237 # define NI_NOFQDN 0x04
238 # define NI_NAMEREQD 0x08
239 # define NI_DGRAM 0x10
242 # ifndef HAVE_STRUCT_ADDRINFO
250 struct sockaddr *ai_addr;
252 struct addrinfo *ai_next;
254 # define AI_PASSIVE 1
255 # define AI_CANONNAME 2
256 # define AI_NUMERICHOST 4
257 # endif /* if !HAVE_STRUCT_ADDRINFO */
259 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
260 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
261 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
262 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
265 static inline vlc_bool_t
266 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
268 switch (addr->sa_family)
273 struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
274 if ((size_t)len < sizeof (*v4))
276 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
280 #ifdef IN6_IS_ADDR_MULTICAST
283 struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
284 if ((size_t)len < sizeof (*v6))
286 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
297 * net_AddressIsMulticast
298 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
299 * or the address is not a valid address.
301 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
303 struct addrinfo hints, *res;
305 memset (&hints, 0, sizeof (hints));
306 hints.ai_socktype = SOCK_DGRAM; /* UDP */
307 hints.ai_flags = AI_NUMERICHOST;
309 int i = vlc_getaddrinfo (p_object, psz_addr, 0,
313 msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
314 psz_addr, vlc_gai_strerror (i));
318 vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
319 vlc_freeaddrinfo (res);
323 static inline int net_GetSockAddress( int fd, char *address, int *port )
325 struct sockaddr_storage addr;
326 socklen_t addrlen = sizeof( addr );
328 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
329 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
330 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
334 static inline int net_GetPeerAddress( int fd, char *address, int *port )
336 struct sockaddr_storage addr;
337 socklen_t addrlen = sizeof( addr );
339 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
340 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
341 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
345 static inline uint16_t net_GetPort (const struct sockaddr *addr)
347 switch (addr->sa_family)
351 return ((const struct sockaddr_in6 *)addr)->sin6_port;
354 return ((const struct sockaddr_in *)addr)->sin_port;
359 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
361 switch (addr->sa_family)
365 ((struct sockaddr_in6 *)addr)->sin6_port = port;
369 ((struct sockaddr_in *)addr)->sin_port = port;