]> git.sesse.net Git - vlc/blobdiff - include/vlc_network.h
Merge branch 'master' into lpcm_encoder
[vlc] / include / vlc_network.h
index bece596243b2b556c8eaca4f17c5eb9fc71e80ca..0a51a12ee3107d0ca4c83f87685519712938de4c 100644 (file)
@@ -2,6 +2,7 @@
  * vlc_network.h: interface to communicate with network plug-ins
  *****************************************************************************
  * Copyright (C) 2002-2005 the VideoLAN team
+ * Copyright © 2006-2007 Rémi Denis-Courmont
  * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_NETWORK_H
+# define VLC_NETWORK_H
 
-#ifndef __VLC_NETWORK_H
-# define __VLC_NETWORK_H
+/**
+ * \file
+ * This file defines interface to communicate with network plug-ins
+ */
 
 #if defined( WIN32 )
-#   if defined(UNDER_CE) && defined(sockaddr_storage)
-#       undef sockaddr_storage
-#   endif
-#   if defined(UNDER_CE)
-#       define HAVE_STRUCT_ADDRINFO
-#   else
+#   if !defined(UNDER_CE)
 #       define _NO_OLDNAMES 1
 #       include <io.h>
 #   endif
 #   define ENETUNREACH WSAENETUNREACH
 #   define net_errno (WSAGetLastError())
 extern const char *net_strerror( int val );
-#else
-#   if HAVE_SYS_SOCKET_H
-#      include <sys/socket.h>
+
+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;
+};
+
+#   ifndef IPV6_V6ONLY
+#       define IPV6_V6ONLY 27
 #   endif
-#   if HAVE_NETINET_IN_H
+#else
+#   include <sys/socket.h>
+#   ifdef HAVE_NETINET_IN_H
 #      include <netinet/in.h>
 #   endif
-#   if HAVE_ARPA_INET_H
+#   ifdef HAVE_ARPA_INET_H
 #      include <arpa/inet.h>
 #   elif defined( SYS_BEOS )
 #      include <net/netdb.h>
 #   endif
 #   include <netdb.h>
 #   define net_errno errno
-#   define net_strerror strerror
 #endif
 
+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 );
+
 # ifdef __cplusplus
 extern "C" {
 # endif
@@ -69,43 +89,51 @@ extern "C" {
 /* Portable networking layer communication */
 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
 
-#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
-#define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
-VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
+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)
 
-int *net_Listen (vlc_object_t *p_this, const char *psz_host, int i_port,
-                                int family, int socktype, int protocol);
-VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
+VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
 
-#define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
-VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
+#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
+                                          SOCK_STREAM, IPPROTO_TCP)
 
-#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
-VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
+static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
+{
+    return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
+}
+#define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
+
+VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
+
+VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
+#define net_Accept(a, b) \
+        net_Accept(VLC_OBJECT(a), b)
 
-#define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
-VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
+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)
 
 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 {
-    return net_ConnectDgram (obj, host, port, hlim, 0);
+    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 }
 
+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)
+
 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 {
-    return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
+    return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 }
 
-#define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
-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 ) );
-
-VLC_EXPORT( void, net_Close, ( int fd ) );
 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 
-VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                    socklen_t addrlen);
 
+VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
+
 /* Functions to read from or write to the networking layer */
 struct virtual_socket_t
 {
@@ -114,52 +142,37 @@ struct virtual_socket_t
     int (*pf_send) ( void *, const void *, int );
 };
 
-#define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
-VLC_EXPORT( int, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, vlc_bool_t b_retry ) );
-
-#define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
-VLC_EXPORT( int, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, mtime_t i_wait ) );
+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)
 
-#define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
-VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, const v_socket_t *const *, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
 
-#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
+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 ) );
+#define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
+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)
 
-#define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
-VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
+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) );
+struct pollfd;
+VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));
 
-VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
 
-#define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
-
-
-#ifndef HAVE_INET_PTON
-/* only in core, so no need for C++ extern "C" */
-int inet_pton(int af, const char *src, void *dst);
-#endif
-
-
-/*****************************************************************************
- * net_StopRecv/Send
- *****************************************************************************
- * Wrappers for shutdown()
- *****************************************************************************/
-#if defined (SHUT_WR)
-/* the standard way */
-# define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
-# define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
-#elif defined (SD_SEND)
-/* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
-# define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
-# define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
+#ifdef WIN32
+/* Microsoft: same semantic, same value, different name... go figure */
+# define SHUT_RD SD_RECEIVE
+# define SHUT_WR SD_SEND
+# define SHUT_RDWR SD_BOTH
+# define net_Close( fd ) closesocket ((SOCKET)fd)
 #else
-# ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
-#  warning FIXME: implement shutdown on your platform!
-# endif
-# define net_StopSend( fd ) (void)0
-# define net_StopRecv( fd ) (void)0
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+# define net_Close( fd ) (void)close (fd)
 #endif
 
 /* Portable network names/addresses resolution layer */
@@ -195,8 +208,11 @@ int inet_pton(int af, const char *src, void *dst);
 # ifndef EAI_MEMORY
 #  define EAI_MEMORY -10
 # endif
+#ifndef EAI_OVERFLOW
+#  define EAI_OVERFLOW -11
+#endif
 # ifndef EAI_SYSTEM
-#  define EAI_SYSTEM -11
+#  define EAI_SYSTEM -12
 # endif
 
 
@@ -206,38 +222,15 @@ int inet_pton(int af, const char *src, void *dst);
 # endif
 # define NI_MAXNUMERICHOST 64
 
-# ifndef NI_NUMERICHOST
-#  define NI_NUMERICHOST 0x01
-#  define NI_NUMERICSERV 0x02
-#  define NI_NOFQDN      0x04
-#  define NI_NAMEREQD    0x08
-#  define NI_DGRAM       0x10
-# endif
-
-# ifndef HAVE_STRUCT_ADDRINFO
-struct addrinfo
-{
-    int ai_flags;
-    int ai_family;
-    int ai_socktype;
-    int ai_protocol;
-    size_t ai_addrlen;
-    struct sockaddr *ai_addr;
-    char *ai_canonname;
-    struct addrinfo *ai_next;
-};
-#  define AI_PASSIVE     1
-#  define AI_CANONNAME   2
-#  define AI_NUMERICHOST 4
-# endif /* if !HAVE_STRUCT_ADDRINFO */
+#ifndef AI_NUMERICSERV
+# define AI_NUMERICSERV 0
+#endif
 
-VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
-VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 
 
-static inline vlc_bool_t
+static inline bool
 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 {
     switch (addr->sa_family)
@@ -245,9 +238,9 @@ net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 #ifdef IN_MULTICAST
         case AF_INET:
         {
-            struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
+            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
             if ((size_t)len < sizeof (*v4))
-                return VLC_FALSE;
+                return false;
             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
         }
 #endif
@@ -255,46 +248,18 @@ net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 #ifdef IN6_IS_ADDR_MULTICAST
         case AF_INET6:
         {
-            struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
+            const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
             if ((size_t)len < sizeof (*v6))
-                return VLC_FALSE;
+                return false;
             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
         }
 #endif
     }
 
-    return VLC_FALSE;
+    return false;
 }
 
 
-
-/**
- * net_AddressIsMulticast
- * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
- * or the address is not a valid address.
- */
-static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
-{
-    struct addrinfo hints, *res;
-
-    memset (&hints, 0, sizeof (hints));
-    hints.ai_socktype = SOCK_DGRAM; /* UDP */
-    hints.ai_flags = AI_NUMERICHOST;
-
-    int i = vlc_getaddrinfo (p_object, psz_addr, 0,
-                             &hints, &res);
-    if (i)
-    {
-        msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
-                 psz_addr, vlc_gai_strerror (i));
-        return VLC_FALSE;
-    }
-
-    vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
-    vlc_freeaddrinfo (res);
-    return b;
-}
-
 static inline int net_GetSockAddress( int fd, char *address, int *port )
 {
     struct sockaddr_storage addr;
@@ -331,6 +296,20 @@ static inline uint16_t net_GetPort (const struct sockaddr *addr)
     return 0;
 }
 
+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;
+        break;
+#endif
+        case AF_INET:
+            ((struct sockaddr_in *)addr)->sin_port = port;
+        break;
+    }
+}
 # ifdef __cplusplus
 }
 # endif