1 /*****************************************************************************
2 * vlc_network.h: interface to communicate with network plug-ins
3 *****************************************************************************
4 * Copyright (C) 2002-2005 the VideoLAN team
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * RĂ©mi Denis-Courmont <rem # videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
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 General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 #if !defined( __LIBVLC__ )
27 #error You are not libvlc or one of its plugins. You cannot include this file
30 #ifndef __VLC_NETWORK_H
31 # define __VLC_NETWORK_H
34 # if defined(UNDER_CE) && defined(sockaddr_storage)
35 # undef sockaddr_storage
37 # if defined(UNDER_CE)
38 # define HAVE_STRUCT_ADDRINFO
40 # define _NO_OLDNAMES 1
43 # include <winsock2.h>
44 # include <ws2tcpip.h>
45 # define ENETUNREACH WSAENETUNREACH
46 # define net_errno (WSAGetLastError())
47 extern const char *net_strerror( int val );
49 # if HAVE_SYS_SOCKET_H
50 # include <sys/socket.h>
52 # if HAVE_NETINET_IN_H
53 # include <netinet/in.h>
56 # include <arpa/inet.h>
57 # elif defined( SYS_BEOS )
58 # include <net/netdb.h>
61 # define net_errno errno
62 # define net_strerror strerror
69 /* Portable networking layer communication */
70 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
72 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
73 #define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
74 VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
76 int *net_Listen (vlc_object_t *p_this, const char *psz_host, int i_port,
77 int family, int socktype, int protocol);
78 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
80 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
81 VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
83 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
84 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
86 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
87 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
89 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
91 return net_ConnectDgram (obj, host, port, hlim, 0);
94 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
96 return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
99 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
100 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 ) );
102 VLC_EXPORT( void, net_Close, ( int fd ) );
103 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
105 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
106 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
109 /* Functions to read from or write to the networking layer */
110 struct virtual_socket_t
113 int (*pf_recv) ( void *, void *, int );
114 int (*pf_send) ( void *, const void *, int );
117 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
118 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 ) );
120 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
121 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 ) );
123 #define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
124 VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, const v_socket_t *const *, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
126 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
127 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int 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( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
134 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
135 VLC_EXPORT( int, __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 int inet_pton(int af, const char *src, void *dst);
144 /*****************************************************************************
146 *****************************************************************************
147 * Wrappers for shutdown()
148 *****************************************************************************/
149 #if defined (SHUT_WR)
150 /* the standard way */
151 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
152 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
153 #elif defined (SD_SEND)
154 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
155 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
156 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
158 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
159 # warning FIXME: implement shutdown on your platform!
161 # define net_StopSend( fd ) (void)0
162 # define net_StopRecv( fd ) (void)0
165 /* Portable network names/addresses resolution layer */
167 /* GAI error codes */
168 # ifndef EAI_BADFLAGS
169 # define EAI_BADFLAGS -1
172 # define EAI_NONAME -2
175 # define EAI_AGAIN -3
181 # define EAI_NODATA -5
184 # define EAI_FAMILY -6
186 # ifndef EAI_SOCKTYPE
187 # define EAI_SOCKTYPE -7
190 # define EAI_SERVICE -8
192 # ifndef EAI_ADDRFAMILY
193 # define EAI_ADDRFAMILY -9
196 # define EAI_MEMORY -10
199 # define EAI_SYSTEM -11
204 # define NI_MAXHOST 1025
205 # define NI_MAXSERV 32
207 # define NI_MAXNUMERICHOST 64
209 # ifndef NI_NUMERICHOST
210 # define NI_NUMERICHOST 0x01
211 # define NI_NUMERICSERV 0x02
212 # define NI_NOFQDN 0x04
213 # define NI_NAMEREQD 0x08
214 # define NI_DGRAM 0x10
217 # ifndef HAVE_STRUCT_ADDRINFO
225 struct sockaddr *ai_addr;
227 struct addrinfo *ai_next;
229 # define AI_PASSIVE 1
230 # define AI_CANONNAME 2
231 # define AI_NUMERICHOST 4
232 # endif /* if !HAVE_STRUCT_ADDRINFO */
234 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
235 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
236 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
237 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
240 static inline vlc_bool_t
241 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
243 switch (addr->sa_family)
248 struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
249 if ((size_t)len < sizeof (*v4))
251 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
255 #ifdef IN6_IS_ADDR_MULTICAST
258 struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
259 if ((size_t)len < sizeof (*v6))
261 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
272 * net_AddressIsMulticast
273 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
274 * or the address is not a valid address.
276 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
278 struct addrinfo hints, *res;
280 memset (&hints, 0, sizeof (hints));
281 hints.ai_socktype = SOCK_DGRAM; /* UDP */
282 hints.ai_flags = AI_NUMERICHOST;
284 int i = vlc_getaddrinfo (p_object, psz_addr, 0,
288 msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
289 psz_addr, vlc_gai_strerror (i));
293 vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
294 vlc_freeaddrinfo (res);
298 static inline int net_GetSockAddress( int fd, char *address, int *port )
300 struct sockaddr_storage addr;
301 socklen_t addrlen = sizeof( addr );
303 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
304 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
305 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
309 static inline int net_GetPeerAddress( int fd, char *address, int *port )
311 struct sockaddr_storage addr;
312 socklen_t addrlen = sizeof( addr );
314 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
315 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
316 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
320 static inline uint16_t net_GetPort (const struct sockaddr *addr)
322 switch (addr->sa_family)
326 return ((const struct sockaddr_in6 *)addr)->sin6_port;
329 return ((const struct sockaddr_in *)addr)->sin_port;
334 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
336 switch (addr->sa_family)
340 ((struct sockaddr_in6 *)addr)->sin6_port = port;
344 ((struct sockaddr_in *)addr)->sin_port = port;