libstream_out_standard_plugin: fix linkage on OS/2
[vlc.git] / include / vlc_network.h
1 /*****************************************************************************
2  * vlc_network.h: interface to communicate with network plug-ins
3  *****************************************************************************
4  * Copyright (C) 2002-2005 VLC authors and VideoLAN
5  * Copyright © 2006-2007 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Laurent Aimar <fenrir@via.ecp.fr>
10  *          Rémi Denis-Courmont <rem # videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 of the License, or
15  * (at your option) any later version.
16  *
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 Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifndef VLC_NETWORK_H
28 # define VLC_NETWORK_H
29
30 /**
31  * \file
32  * This file defines interface to communicate with network plug-ins
33  */
34
35 #if defined( _WIN32 )
36 #   define _NO_OLDNAMES 1
37 #   include <io.h>
38 #   include <winsock2.h>
39 #   include <ws2tcpip.h>
40 #   define net_errno (WSAGetLastError())
41
42 struct iovec
43 {
44     void  *iov_base;
45     size_t iov_len;
46 };
47
48 struct msghdr
49 {
50     void         *msg_name;
51     size_t        msg_namelen;
52     struct iovec *msg_iov;
53     size_t        msg_iovlen;
54     void         *msg_control;
55     size_t        msg_controllen;
56     int           msg_flags;
57 };
58
59 #   ifndef IPV6_V6ONLY
60 #       define IPV6_V6ONLY 27
61 #   endif
62 #else
63 #   include <sys/types.h>
64 #   include <unistd.h>
65 #   include <sys/socket.h>
66 #   include <netinet/in.h>
67 #   include <netdb.h>
68 #   define net_errno errno
69 #endif
70
71 #if defined( __SYMBIAN32__ )
72 #   undef AF_INET6
73 #   undef IN6_IS_ADDR_MULTICAST
74 #   undef IPV6_V6ONLY
75 #   undef IPV6_MULTICAST_HOPS
76 #   undef IPV6_MULTICAST_IF
77 #   undef IPV6_TCLASS
78 #   undef IPV6_JOIN_GROUP
79 #endif
80
81 VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
82
83 struct sockaddr;
84 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
85
86 # ifdef __cplusplus
87 extern "C" {
88 # endif
89
90 /* Portable networking layer communication */
91 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
92
93 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
94 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
95
96 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
97
98 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
99                                           SOCK_STREAM, IPPROTO_TCP)
100
101 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
102 {
103     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
104 }
105 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
106
107 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
108
109 VLC_API int net_Accept( vlc_object_t *, int * );
110 #define net_Accept(a, b) \
111         net_Accept(VLC_OBJECT(a), b)
112
113 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
114 #define net_ConnectDgram(a, b, c, d, e ) \
115         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
116
117 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
118 {
119     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
120 }
121
122 VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int proto );
123 #define net_OpenDgram( a, b, c, d, e, g ) \
124         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
125
126 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
127 {
128     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
129 }
130
131 VLC_API void net_ListenClose( int *fd );
132
133 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
134                    socklen_t addrlen);
135
136 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
137
138 /* Functions to read from or write to the networking layer */
139 struct virtual_socket_t
140 {
141     void *p_sys;
142     int (*pf_recv) ( void *, void *, size_t );
143     int (*pf_send) ( void *, const void *, size_t );
144 };
145
146 VLC_API 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 );
147 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
148 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
149 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
150 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
151 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
152
153
154 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
155 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
156 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
157 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
158
159 #ifdef _WIN32
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)
165 #else
166 # ifdef __OS2__
167 #  define SHUT_RD    0
168 #  define SHUT_WR    1
169 #  define SHUT_RDWR  2
170 # endif
171 # define net_Close( fd ) (void)close (fd)
172 #endif
173
174 /* Portable network names/addresses resolution layer */
175
176 /* GAI error codes */
177 # ifndef EAI_BADFLAGS
178 #  define EAI_BADFLAGS -1
179 # endif
180 # ifndef EAI_NONAME
181 #  define EAI_NONAME -2
182 # endif
183 # ifndef EAI_AGAIN
184 #  define EAI_AGAIN -3
185 # endif
186 # ifndef EAI_FAIL
187 #  define EAI_FAIL -4
188 # endif
189 # ifndef EAI_NODATA
190 #  define EAI_NODATA -5
191 # endif
192 # ifndef EAI_FAMILY
193 #  define EAI_FAMILY -6
194 # endif
195 # ifndef EAI_SOCKTYPE
196 #  define EAI_SOCKTYPE -7
197 # endif
198 # ifndef EAI_SERVICE
199 #  define EAI_SERVICE -8
200 # endif
201 # ifndef EAI_ADDRFAMILY
202 #  define EAI_ADDRFAMILY -9
203 # endif
204 # ifndef EAI_MEMORY
205 #  define EAI_MEMORY -10
206 # endif
207 #ifndef EAI_OVERFLOW
208 #  define EAI_OVERFLOW -11
209 #endif
210 # ifndef EAI_SYSTEM
211 #  define EAI_SYSTEM -12
212 # endif
213
214
215 # ifndef NI_MAXHOST
216 #  define NI_MAXHOST 1025
217 #  define NI_MAXSERV 32
218 # endif
219 # define NI_MAXNUMERICHOST 64
220
221 #ifndef AI_NUMERICSERV
222 # define AI_NUMERICSERV 0
223 #endif
224 #ifndef AI_IDN
225 # define AI_IDN 0 /* GNU/libc extension */
226 #endif
227
228 #ifdef _WIN32
229 # undef gai_strerror
230 # define gai_strerror gai_strerrorA
231 #endif
232
233 #ifdef __OS2__
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
240 # endif
241
242 # define AI_PASSIVE     1
243 # define AI_CANONNAME   2
244 # define AI_NUMERICHOST 4
245
246 VLC_API const char *gai_strerror( int errnum );
247
248 VLC_API int  getaddrinfo ( const char *, const char *,
249                            const struct addrinfo *, struct addrinfo ** );
250 VLC_API void freeaddrinfo( struct addrinfo * );
251 VLC_API int  getnameinfo ( const struct sockaddr *, socklen_t,
252                            char *, int, char *, int, int );
253 #endif
254
255 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
256 VLC_API int vlc_getaddrinfo (const char *, unsigned,
257                              const struct addrinfo *, struct addrinfo **);
258
259
260 #ifdef __OS2__
261 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
262 struct in6_addr
263 {
264     uint8_t s6_addr[16];
265 };
266
267 struct sockaddr_in6
268 {
269     uint8_t         sin6_len;
270     uint8_t         sin6_family;
271     uint16_t        sin6_port;
272     uint32_t        sin6_flowinfo;
273     struct in6_addr sin6_addr;
274     uint32_t        sin6_scope_id;
275 };
276
277 # define IN6_IS_ADDR_MULTICAST(a)   (((__const uint8_t *) (a))[0] == 0xff)
278
279 static const struct in6_addr in6addr_any =
280     { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
281 #endif
282
283 static inline bool
284 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
285 {
286     switch (addr->sa_family)
287     {
288 #ifdef IN_MULTICAST
289         case AF_INET:
290         {
291             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
292             if ((size_t)len < sizeof (*v4))
293                 return false;
294             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
295         }
296 #endif
297
298 #ifdef IN6_IS_ADDR_MULTICAST
299         case AF_INET6:
300         {
301             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
302             if ((size_t)len < sizeof (*v6))
303                 return false;
304             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
305         }
306 #endif
307     }
308
309     return false;
310 }
311
312
313 static inline int net_GetSockAddress( int fd, char *address, int *port )
314 {
315     struct sockaddr_storage addr;
316     socklen_t addrlen = sizeof( addr );
317
318     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
319         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
320                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
321         ? VLC_EGENERIC : 0;
322 }
323
324 static inline int net_GetPeerAddress( int fd, char *address, int *port )
325 {
326     struct sockaddr_storage addr;
327     socklen_t addrlen = sizeof( addr );
328
329     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
330         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
331                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
332         ? VLC_EGENERIC : 0;
333 }
334
335 static inline uint16_t net_GetPort (const struct sockaddr *addr)
336 {
337     switch (addr->sa_family)
338     {
339 #ifdef AF_INET6
340         case AF_INET6:
341             return ((const struct sockaddr_in6 *)addr)->sin6_port;
342 #endif
343         case AF_INET:
344             return ((const struct sockaddr_in *)addr)->sin_port;
345     }
346     return 0;
347 }
348
349 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
350 {
351     switch (addr->sa_family)
352     {
353 #ifdef AF_INET6
354         case AF_INET6:
355             ((struct sockaddr_in6 *)addr)->sin6_port = port;
356         break;
357 #endif
358         case AF_INET:
359             ((struct sockaddr_in *)addr)->sin_port = port;
360         break;
361     }
362 }
363
364 VLC_API char *vlc_getProxyUrl(const char *);
365
366 # ifdef __cplusplus
367 }
368 # endif
369
370 #endif