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)
36 # define _NO_OLDNAMES 1
39 # include <winsock2.h>
40 # include <ws2tcpip.h>
41 # define ENETUNREACH WSAENETUNREACH
42 # define net_errno (WSAGetLastError())
43 # define AI_NUMERICSERV 0
44 extern const char *net_strerror( int val );
56 struct iovec *msg_iov;
59 size_t msg_controllen;
63 #define sendmsg vlc_sendmsg
64 #define recvmsg vlc_recvmsg
67 # define IPV6_V6ONLY 27
70 # include <sys/socket.h>
71 # ifdef HAVE_NETINET_IN_H
72 # include <netinet/in.h>
74 # ifdef HAVE_ARPA_INET_H
75 # include <arpa/inet.h>
76 # elif defined( SYS_BEOS )
77 # include <net/netdb.h>
80 # define net_errno errno
83 VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
84 VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );
90 /* Portable networking layer communication */
91 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
92 int net_SetupSocket (int fd);
94 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
95 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
97 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
99 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
100 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
102 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
104 return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
108 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
110 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
111 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
113 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
114 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
116 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
118 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
121 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
122 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 ) );
124 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
126 return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
129 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
131 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
134 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
136 /* Functions to read from or write to the networking layer */
137 struct virtual_socket_t
140 int (*pf_recv) ( void *, void *, int );
141 int (*pf_send) ( void *, const void *, int );
144 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
145 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, bool b_retry ) );
147 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
148 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 ) );
150 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
151 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
153 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) LIBVLC_FORMAT( 4, 5 ) );
155 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
156 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
159 /* Don't go to an extra call layer if we have the symbol */
160 #ifndef HAVE_INET_PTON
161 #define inet_pton vlc_inet_pton
163 #ifndef HAVE_INET_NTOP
164 #define inet_ntop vlc_inet_ntop
167 VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
168 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
169 char *dst, socklen_t cnt) );
177 POLLERR=8, // unsupported stub
178 POLLHUP=16, // unsupported stub
179 POLLNVAL=32 // unsupported stub
189 VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
193 /* Microsoft: same semantic, same value, different name... go figure */
194 # define SHUT_RD SD_RECEIVE
195 # define SHUT_WR SD_SEND
196 # define SHUT_RDWR SD_BOTH
197 # define net_Close( fd ) closesocket ((SOCKET)fd)
202 # define net_Close( fd ) (void)close (fd)
205 /* Portable network names/addresses resolution layer */
207 /* GAI error codes */
208 # ifndef EAI_BADFLAGS
209 # define EAI_BADFLAGS -1
212 # define EAI_NONAME -2
215 # define EAI_AGAIN -3
221 # define EAI_NODATA -5
224 # define EAI_FAMILY -6
226 # ifndef EAI_SOCKTYPE
227 # define EAI_SOCKTYPE -7
230 # define EAI_SERVICE -8
232 # ifndef EAI_ADDRFAMILY
233 # define EAI_ADDRFAMILY -9
236 # define EAI_MEMORY -10
239 # define EAI_OVERFLOW -11
242 # define EAI_SYSTEM -12
247 # define NI_MAXHOST 1025
248 # define NI_MAXSERV 32
250 # define NI_MAXNUMERICHOST 64
252 # ifndef NI_NUMERICHOST
253 # define NI_NUMERICHOST 0x01
254 # define NI_NUMERICSERV 0x02
255 # define NI_NOFQDN 0x04
256 # define NI_NAMEREQD 0x08
257 # define NI_DGRAM 0x10
260 # ifndef HAVE_STRUCT_ADDRINFO
268 struct sockaddr *ai_addr;
270 struct addrinfo *ai_next;
272 # define AI_PASSIVE 1
273 # define AI_CANONNAME 2
274 # define AI_NUMERICHOST 4
275 # endif /* if !HAVE_STRUCT_ADDRINFO */
277 /* Mac OS X doesn't define that one */
278 #ifndef AI_NUMERICSERV
279 #define AI_NUMERICSERV 0
282 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
283 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
284 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
285 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
289 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
291 switch (addr->sa_family)
296 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
297 if ((size_t)len < sizeof (*v4))
299 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
303 #ifdef IN6_IS_ADDR_MULTICAST
306 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
307 if ((size_t)len < sizeof (*v6))
309 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
318 static inline int net_GetSockAddress( int fd, char *address, int *port )
320 struct sockaddr_storage addr;
321 socklen_t addrlen = sizeof( addr );
323 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
324 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
325 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
329 static inline int net_GetPeerAddress( int fd, char *address, int *port )
331 struct sockaddr_storage addr;
332 socklen_t addrlen = sizeof( addr );
334 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
335 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
336 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
340 static inline uint16_t net_GetPort (const struct sockaddr *addr)
342 switch (addr->sa_family)
346 return ((const struct sockaddr_in6 *)addr)->sin6_port;
349 return ((const struct sockaddr_in *)addr)->sin_port;
354 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
356 switch (addr->sa_family)
360 ((struct sockaddr_in6 *)addr)->sin6_port = port;
364 ((struct sockaddr_in *)addr)->sin_port = port;