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 *****************************************************************************/
28 # define VLC_NETWORK_H
32 * This file defines interface to communicate with network plug-ins
36 # if !defined(UNDER_CE)
37 # define _NO_OLDNAMES 1
40 # include <winsock2.h>
41 # include <ws2tcpip.h>
42 # define ENETUNREACH WSAENETUNREACH
43 # define net_errno (WSAGetLastError())
44 extern const char *net_strerror( int val );
56 struct iovec *msg_iov;
59 size_t msg_controllen;
64 # define IPV6_V6ONLY 27
67 # include <sys/socket.h>
68 # ifdef HAVE_NETINET_IN_H
69 # include <netinet/in.h>
71 # ifdef HAVE_ARPA_INET_H
72 # include <arpa/inet.h>
73 # elif defined( SYS_BEOS )
74 # include <net/netdb.h>
77 # define net_errno errno
84 /* Portable networking layer communication */
85 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
87 VLC_EXPORT( int, net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
88 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
90 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
92 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
94 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
96 return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
98 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
100 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
102 VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
103 #define net_Accept(a, b) \
104 net_Accept(VLC_OBJECT(a), b)
106 VLC_EXPORT( int, net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
107 #define net_ConnectDgram(a, b, c, d, e ) \
108 net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
110 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
112 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
115 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 ) );
116 #define net_OpenDgram( a, b, c, d, e, g, h ) \
117 net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
119 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
121 return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
124 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
126 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
129 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
131 /* Functions to read from or write to the networking layer */
132 struct virtual_socket_t
135 int (*pf_recv) ( void *, void *, int );
136 int (*pf_send) ( void *, const void *, int );
139 VLC_EXPORT( ssize_t, net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry ) );
140 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
141 VLC_EXPORT( ssize_t, net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data ) );
142 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
143 VLC_EXPORT( char *, net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
144 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
147 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 ) );
148 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
149 VLC_EXPORT( ssize_t, net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
150 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
152 VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
153 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
154 char *dst, socklen_t cnt) );
156 VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));
160 /* Microsoft: same semantic, same value, different name... go figure */
161 # define SHUT_RD SD_RECEIVE
162 # define SHUT_WR SD_SEND
163 # define SHUT_RDWR SD_BOTH
164 # define net_Close( fd ) closesocket ((SOCKET)fd)
169 # define net_Close( fd ) (void)close (fd)
172 /* Portable network names/addresses resolution layer */
174 /* GAI error codes */
175 # ifndef EAI_BADFLAGS
176 # define EAI_BADFLAGS -1
179 # define EAI_NONAME -2
182 # define EAI_AGAIN -3
188 # define EAI_NODATA -5
191 # define EAI_FAMILY -6
193 # ifndef EAI_SOCKTYPE
194 # define EAI_SOCKTYPE -7
197 # define EAI_SERVICE -8
199 # ifndef EAI_ADDRFAMILY
200 # define EAI_ADDRFAMILY -9
203 # define EAI_MEMORY -10
206 # define EAI_OVERFLOW -11
209 # define EAI_SYSTEM -12
214 # define NI_MAXHOST 1025
215 # define NI_MAXSERV 32
217 # define NI_MAXNUMERICHOST 64
219 # ifndef NI_NUMERICHOST
220 # define NI_NUMERICHOST 0x01
221 # define NI_NUMERICSERV 0x02
222 # define NI_NOFQDN 0x04
223 # define NI_NAMEREQD 0x08
224 # define NI_DGRAM 0x10
227 # ifndef HAVE_STRUCT_ADDRINFO
235 struct sockaddr *ai_addr;
237 struct addrinfo *ai_next;
239 # define AI_PASSIVE 1
240 # define AI_CANONNAME 2
241 # define AI_NUMERICHOST 4
242 # endif /* if !HAVE_STRUCT_ADDRINFO */
244 #ifndef AI_NUMERICSERV
245 # define AI_NUMERICSERV 0
248 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
249 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
250 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
251 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
255 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
257 switch (addr->sa_family)
262 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
263 if ((size_t)len < sizeof (*v4))
265 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
269 #ifdef IN6_IS_ADDR_MULTICAST
272 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
273 if ((size_t)len < sizeof (*v6))
275 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
284 static inline int net_GetSockAddress( int fd, char *address, int *port )
286 struct sockaddr_storage addr;
287 socklen_t addrlen = sizeof( addr );
289 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
290 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
291 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
295 static inline int net_GetPeerAddress( int fd, char *address, int *port )
297 struct sockaddr_storage addr;
298 socklen_t addrlen = sizeof( addr );
300 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
301 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
302 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
306 static inline uint16_t net_GetPort (const struct sockaddr *addr)
308 switch (addr->sa_family)
312 return ((const struct sockaddr_in6 *)addr)->sin6_port;
315 return ((const struct sockaddr_in *)addr)->sin_port;
320 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
322 switch (addr->sa_family)
326 ((struct sockaddr_in6 *)addr)->sin6_port = port;
330 ((struct sockaddr_in *)addr)->sin_port = port;