include/vlc_network.h

   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
   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
  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.
  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 General Public License for more details.
  21  *
  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  *****************************************************************************/
  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 #   if !defined(UNDER_CE)
  37 #       define _NO_OLDNAMES 1
  38 #       include <io.h>
  39 #   endif
  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 );
  45
  46 struct iovec
  47 {
  48     void  *iov_base;
  49     size_t iov_len;
  50 };
  51
  52 struct msghdr
  53 {
  54     void         *msg_name;
  55     size_t        msg_namelen;
  56     struct iovec *msg_iov;
  57     size_t        msg_iovlen;
  58     void         *msg_control;
  59     size_t        msg_controllen;
  60     int           msg_flags;
  61 };
  62
  63 #   ifndef IPV6_V6ONLY
  64 #       define IPV6_V6ONLY 27
  65 #   endif
  66 #else
  67 #   include <sys/socket.h>
  68 #   include <netinet/in.h>
  69 #   include <netdb.h>
  70 #   define net_errno errno
  71 #endif
  72
  73 #if defined( __SYMBIAN32__ )
  74 #   undef AF_INET6
  75 #   undef IN6_IS_ADDR_MULTICAST
  76 #   undef IPV6_V6ONLY
  77 #   undef IPV6_MULTICAST_HOPS
  78 #   undef IPV6_MULTICAST_IF
  79 #   undef IPV6_TCLASS
  80 #   undef IPV6_JOIN_GROUP
  81 #endif
  82
  83 int vlc_socket (int, int, int, bool nonblock) VLC_USED;
  84
  85 struct sockaddr;
  86 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
  87
  88 # ifdef __cplusplus
  89 extern "C" {
  90 # endif
  91
  92 /* Portable networking layer communication */
  93 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  94
  95 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
  96 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
  97
  98 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
  99
 100 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
 101                                           SOCK_STREAM, IPPROTO_TCP)
 102
 103 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
 104 {
 105     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
 106 }
 107 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
 108
 109 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
 110
 111 VLC_API int net_Accept( vlc_object_t *, int * );
 112 #define net_Accept(a, b) \
 113         net_Accept(VLC_OBJECT(a), b)
 114
 115 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
 116 #define net_ConnectDgram(a, b, c, d, e ) \
 117         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 118
 119 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 120 {
 121     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 122 }
 123
 124 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 );
 125 #define net_OpenDgram( a, b, c, d, e, g ) \
 126         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
 127
 128 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 129 {
 130     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
 131 }
 132
 133 VLC_API void net_ListenClose( int *fd );
 134
 135 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 136                    socklen_t addrlen);
 137
 138 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
 139
 140 /* Functions to read from or write to the networking layer */
 141 struct virtual_socket_t
 142 {
 143     void *p_sys;
 144     int (*pf_recv) ( void *, void *, size_t );
 145     int (*pf_send) ( void *, const void *, size_t );
 146 };
 147
 148 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 );
 149 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
 150 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 );
 151 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
 152 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
 153 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
 154
 155
 156 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 );
 157 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
 158 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
 159 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 160
 161 struct pollfd;
 162 VLC_API int vlc_poll(struct pollfd *fds, unsigned nfds, int timeout);
 163
 164
 165 #ifdef WIN32
 166 /* Microsoft: same semantic, same value, different name... go figure */
 167 # define SHUT_RD SD_RECEIVE
 168 # define SHUT_WR SD_SEND
 169 # define SHUT_RDWR SD_BOTH
 170 # define net_Close( fd ) closesocket ((SOCKET)fd)
 171 #else
 172 # ifdef __OS2__
 173 #  define SHUT_RD    0
 174 #  define SHUT_WR    1
 175 #  define SHUT_RDWR  2
 176 # endif
 177 # define net_Close( fd ) (void)close (fd)
 178 #endif
 179
 180 /* Portable network names/addresses resolution layer */
 181
 182 /* GAI error codes */
 183 # ifndef EAI_BADFLAGS
 184 #  define EAI_BADFLAGS -1
 185 # endif
 186 # ifndef EAI_NONAME
 187 #  define EAI_NONAME -2
 188 # endif
 189 # ifndef EAI_AGAIN
 190 #  define EAI_AGAIN -3
 191 # endif
 192 # ifndef EAI_FAIL
 193 #  define EAI_FAIL -4
 194 # endif
 195 # ifndef EAI_NODATA
 196 #  define EAI_NODATA -5
 197 # endif
 198 # ifndef EAI_FAMILY
 199 #  define EAI_FAMILY -6
 200 # endif
 201 # ifndef EAI_SOCKTYPE
 202 #  define EAI_SOCKTYPE -7
 203 # endif
 204 # ifndef EAI_SERVICE
 205 #  define EAI_SERVICE -8
 206 # endif
 207 # ifndef EAI_ADDRFAMILY
 208 #  define EAI_ADDRFAMILY -9
 209 # endif
 210 # ifndef EAI_MEMORY
 211 #  define EAI_MEMORY -10
 212 # endif
 213 #ifndef EAI_OVERFLOW
 214 #  define EAI_OVERFLOW -11
 215 #endif
 216 # ifndef EAI_SYSTEM
 217 #  define EAI_SYSTEM -12
 218 # endif
 219
 220
 221 # ifndef NI_MAXHOST
 222 #  define NI_MAXHOST 1025
 223 #  define NI_MAXSERV 32
 224 # endif
 225 # define NI_MAXNUMERICHOST 64
 226
 227 #ifndef AI_NUMERICSERV
 228 # define AI_NUMERICSERV 0
 229 #endif
 230
 231 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
 232 VLC_API int vlc_getaddrinfo( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** );
 233
 234
 235 static inline bool
 236 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 237 {
 238     switch (addr->sa_family)
 239     {
 240 #ifdef IN_MULTICAST
 241         case AF_INET:
 242         {
 243             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 244             if ((size_t)len < sizeof (*v4))
 245                 return false;
 246             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 247         }
 248 #endif
 249
 250 #ifdef IN6_IS_ADDR_MULTICAST
 251         case AF_INET6:
 252         {
 253             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 254             if ((size_t)len < sizeof (*v6))
 255                 return false;
 256             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 257         }
 258 #endif
 259     }
 260
 261     return false;
 262 }
 263
 264
 265 static inline int net_GetSockAddress( int fd, char *address, int *port )
 266 {
 267     struct sockaddr_storage addr;
 268     socklen_t addrlen = sizeof( addr );
 269
 270     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 271         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 272                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 273         ? VLC_EGENERIC : 0;
 274 }
 275
 276 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 277 {
 278     struct sockaddr_storage addr;
 279     socklen_t addrlen = sizeof( addr );
 280
 281     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 282         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 283                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 284         ? VLC_EGENERIC : 0;
 285 }
 286
 287 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 288 {
 289     switch (addr->sa_family)
 290     {
 291 #ifdef AF_INET6
 292         case AF_INET6:
 293             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 294 #endif
 295         case AF_INET:
 296             return ((const struct sockaddr_in *)addr)->sin_port;
 297     }
 298     return 0;
 299 }
 300
 301 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 302 {
 303     switch (addr->sa_family)
 304     {
 305 #ifdef AF_INET6
 306         case AF_INET6:
 307             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 308         break;
 309 #endif
 310         case AF_INET:
 311             ((struct sockaddr_in *)addr)->sin_port = port;
 312         break;
 313     }
 314 }
 315 # ifdef __cplusplus
 316 }
 317 # endif
 318
 319 #endif