vlc_network.h 9.34 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * vlc_network.h: interface to communicate with network plug-ins
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
4
 * Copyright (C) 2002-2005 the VideoLAN team
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
5
 * Copyright © 2006-2007 Rémi Denis-Courmont
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7
 *
8
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9
 *          Laurent Aimar <fenrir@via.ecp.fr>
10
 *          Rémi Denis-Courmont <rem # videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

27 28
#ifndef VLC_NETWORK_H
# define VLC_NETWORK_H
29

30 31 32 33 34
/**
 * \file
 * This file defines interface to communicate with network plug-ins
 */

35
#if defined( WIN32 )
36
#   if !defined(UNDER_CE)
37
#       define _NO_OLDNAMES 1
38 39
#       include <io.h>
#   endif
40
#   include <winsock2.h>
41
#   include <ws2tcpip.h>
42
#   define ENETUNREACH WSAENETUNREACH
43 44
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

struct iovec
{
    void  *iov_base;
    size_t iov_len;
};

struct msghdr
{
    void         *msg_name;
    size_t        msg_namelen;
    struct iovec *msg_iov;
    size_t        msg_iovlen;
    void         *msg_control;
    size_t        msg_controllen;
    int           msg_flags;
};

63
#   ifndef IPV6_V6ONLY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
64
#       define IPV6_V6ONLY 27
65
#   endif
66
#else
67
#   include <sys/socket.h>
68
#   ifdef HAVE_NETINET_IN_H
69 70
#      include <netinet/in.h>
#   endif
71
#   ifdef HAVE_ARPA_INET_H
72 73
#      include <arpa/inet.h>
#   endif
74
#   include <netdb.h>
75
#   define net_errno errno
76 77
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
78 79 80 81 82
int vlc_socket (int, int, int, bool nonblock) LIBVLC_USED;

struct sockaddr;
VLC_EXPORT( int, vlc_accept, ( int, struct sockaddr *, socklen_t *, bool ) LIBVLC_USED );

83 84 85
# ifdef __cplusplus
extern "C" {
# endif
86

87
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
88 89
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);

90 91
VLC_EXPORT( int, net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
#define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
Laurent Aimar's avatar
 
Laurent Aimar committed
92

93
VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
94

95 96
#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
                                          SOCK_STREAM, IPPROTO_TCP)
97

98
static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
99
{
100
    return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
101
}
102
#define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
103 104 105

VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );

106 107 108
VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
#define net_Accept(a, b) \
        net_Accept(VLC_OBJECT(a), b)
109

110 111 112
VLC_EXPORT( int, net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
#define net_ConnectDgram(a, b, c, d, e ) \
        net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
113 114 115

static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
116
    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
117
}
118

119 120 121
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 ) );
#define net_OpenDgram( a, b, c, d, e, g, h ) \
        net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
122

Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
123 124
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
125
    return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
126
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
127

128
VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
129

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
130 131
int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                   socklen_t addrlen);
Laurent Aimar's avatar
 
Laurent Aimar committed
132

133 134
VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );

135 136 137 138 139 140 141 142
/* Functions to read from or write to the networking layer */
struct virtual_socket_t
{
    void *p_sys;
    int (*pf_recv) ( void *, void *, int );
    int (*pf_send) ( void *, const void *, int );
};

143 144 145 146 147 148
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 ) );
#define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
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 ) );
#define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
VLC_EXPORT( char *, net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
#define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
Laurent Aimar's avatar
 
Laurent Aimar committed
149 150


151
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 ) );
152
#define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
153 154
VLC_EXPORT( ssize_t, net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
#define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
155

156 157 158
VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
                                          char *dst, socklen_t cnt) );
159 160 161
struct pollfd;
VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
162

163
#ifdef WIN32
164 165 166
/* Microsoft: same semantic, same value, different name... go figure */
# define SHUT_RD SD_RECEIVE
# define SHUT_WR SD_SEND
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
167
# define SHUT_RDWR SD_BOTH
168 169
# define net_Close( fd ) closesocket ((SOCKET)fd)
#else
170 171 172
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
173
# define net_Close( fd ) (void)close (fd)
174 175
#endif

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
/* Portable network names/addresses resolution layer */

/* GAI error codes */
# ifndef EAI_BADFLAGS
#  define EAI_BADFLAGS -1
# endif
# ifndef EAI_NONAME
#  define EAI_NONAME -2
# endif
# ifndef EAI_AGAIN
#  define EAI_AGAIN -3
# endif
# ifndef EAI_FAIL
#  define EAI_FAIL -4
# endif
# ifndef EAI_NODATA
#  define EAI_NODATA -5
# endif
# ifndef EAI_FAMILY
#  define EAI_FAMILY -6
# endif
# ifndef EAI_SOCKTYPE
#  define EAI_SOCKTYPE -7
# endif
# ifndef EAI_SERVICE
#  define EAI_SERVICE -8
# endif
# ifndef EAI_ADDRFAMILY
#  define EAI_ADDRFAMILY -9
# endif
# ifndef EAI_MEMORY
#  define EAI_MEMORY -10
# endif
Rémi Denis-Courmont's avatar
Fixups  
Rémi Denis-Courmont committed
209 210 211
#ifndef EAI_OVERFLOW
#  define EAI_OVERFLOW -11
#endif
212
# ifndef EAI_SYSTEM
Rémi Denis-Courmont's avatar
Fixups  
Rémi Denis-Courmont committed
213
#  define EAI_SYSTEM -12
214 215 216 217 218 219 220
# endif


# ifndef NI_MAXHOST
#  define NI_MAXHOST 1025
#  define NI_MAXSERV 32
# endif
221
# define NI_MAXNUMERICHOST 64
222

223
#ifndef AI_NUMERICSERV
224
# define AI_NUMERICSERV 0
225 226
#endif

227
VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
228
VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
229

230

231
static inline bool
232 233 234 235 236 237 238
net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
{
    switch (addr->sa_family)
    {
#ifdef IN_MULTICAST
        case AF_INET:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
239
            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
240
            if ((size_t)len < sizeof (*v4))
241
                return false;
242
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
243 244 245 246 247 248
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
249
            const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
250
            if ((size_t)len < sizeof (*v6))
251
                return false;
252 253 254 255 256
            return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
        }
#endif
    }

257
    return false;
258 259 260
}


261
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
262 263 264 265
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

266
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
267 268 269 270
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
271

272 273 274 275
static inline int net_GetPeerAddress( int fd, char *address, int *port )
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
276

277 278 279 280
    return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
281 282
}

283 284 285 286 287 288 289 290 291 292 293 294 295 296
static inline uint16_t net_GetPort (const struct sockaddr *addr)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            return ((const struct sockaddr_in6 *)addr)->sin6_port;
#endif
        case AF_INET:
            return ((const struct sockaddr_in *)addr)->sin_port;
    }
    return 0;
}

297 298 299 300 301 302 303
static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            ((struct sockaddr_in6 *)addr)->sin6_port = port;
304
        break;
305 306 307
#endif
        case AF_INET:
            ((struct sockaddr_in *)addr)->sin_port = port;
308
        break;
309 310
    }
}
311 312 313 314
# ifdef __cplusplus
}
# endif

315
#endif