+/////////////////////////////////////////////////////////////////////////////
+// Name: wx/private/gsocket.h
+// Purpose: GSocket implementation
+// Authors: Guilhem Lavaux, Vadim Zeitlin
+// Created: April 1997
+// RCS-ID: $Id$
+// Copyright: (c) 1997 Guilhem Lavaux
+// (c) 2008 Vadim Zeitlin
+// Licence: wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_PRIVATE_GSOCKET_H_
+#define _WX_PRIVATE_GSOCKET_H_
+
+#include "wx/defs.h"
+
+#if wxUSE_SOCKETS
+
+#include "wx/dlimpexp.h" /* for WXDLLIMPEXP_NET */
+
+class WXDLLIMPEXP_FWD_NET wxSocketBase;
+
+#include <stddef.h>
+
+/*
+ Including sys/types.h under Cygwin results in the warnings about "fd_set
+ having been defined in sys/types.h" when winsock.h is included later and
+ doesn't seem to be necessary anyhow. It's not needed under Mac neither.
+ */
+#if !defined(__WXMAC__) && !defined(__CYGWIN__) && !defined(__WXWINCE__)
+#include <sys/types.h>
+#endif
+
+#ifdef __WXWINCE__
+#include <stdlib.h>
+#endif
+
+// include the header defining timeval: under Windows this struct is used only
+// with sockets so we need to include winsock.h which we do via windows.h
+#ifdef __WXMSW__
+ #include "wx/msw/wrapwin.h"
+#else
+ #include <sys/time.h> // for timeval
+#endif
+
+enum GAddressType
+{
+ GSOCK_NOFAMILY = 0,
+ GSOCK_INET,
+ GSOCK_INET6,
+ GSOCK_UNIX
+};
+
+enum GSocketStream
+{
+ GSOCK_STREAMED,
+ GSOCK_UNSTREAMED
+};
+
+enum GSocketError
+{
+ GSOCK_NOERROR = 0,
+ GSOCK_INVOP,
+ GSOCK_IOERR,
+ GSOCK_INVADDR,
+ GSOCK_INVSOCK,
+ GSOCK_NOHOST,
+ GSOCK_INVPORT,
+ GSOCK_WOULDBLOCK,
+ GSOCK_TIMEDOUT,
+ GSOCK_MEMERR,
+ GSOCK_OPTERR
+};
+
+/* See below for an explanation on how events work.
+ */
+enum GSocketEvent
+{
+ GSOCK_INPUT = 0,
+ GSOCK_OUTPUT = 1,
+ GSOCK_CONNECTION = 2,
+ GSOCK_LOST = 3,
+ GSOCK_MAX_EVENT = 4
+};
+
+enum
+{
+ GSOCK_INPUT_FLAG = 1 << GSOCK_INPUT,
+ GSOCK_OUTPUT_FLAG = 1 << GSOCK_OUTPUT,
+ GSOCK_CONNECTION_FLAG = 1 << GSOCK_CONNECTION,
+ GSOCK_LOST_FLAG = 1 << GSOCK_LOST
+};
+
+typedef int GSocketEventFlags;
+
+struct GAddress;
+class GSocket;
+
+typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
+ char *cdata);
+
+/*
+ Class providing hooks abstracting the differences between console and GUI
+ applications for socket code.
+
+ We also have different implementations of this class for different platforms
+ allowing us to keep more things in the common code but the main reason for
+ its existence is that we want the same socket code work differently
+ depending on whether it's used from a console or a GUI program. This is
+ achieved by implementing the virtual methods of this class differently in
+ the objects returned by wxConsoleAppTraits::GetSocketFunctionsTable() and
+ the same method in wxGUIAppTraits.
+ */
+class GSocketManager
+{
+public:
+ // set the manager to use, we don't take ownership of it
+ //
+ // this should be called before GSocket_Init(), i.e. before the first
+ // wxSocket object is created, otherwise the manager returned by
+ // wxAppTraits::GetSocketManager() will be used
+ static void Set(GSocketManager *manager);
+
+ // return the manager to use
+ //
+ // this initializes the manager at first use
+ static GSocketManager *Get()
+ {
+ if ( !ms_manager )
+ Init();
+
+ return ms_manager;
+ }
+
+ // called before the first wxSocket is created and should do the
+ // initializations needed in order to use the network
+ //
+ // return true if initialized successfully
+ virtual bool OnInit() = 0;
+
+ // undo the initializations of OnInit()
+ virtual void OnExit() = 0;
+
+
+ // do manager-specific socket initializations: called in the beginning of
+ // the socket initialization
+ virtual bool Init_Socket(GSocket *socket) = 0;
+
+ // called when the socket is being closed
+ //
+ // TODO: merge this with Destroy_Socket(), currently 2 separate functions
+ // are needed because Init_Socket() always allocates manager-specific
+ // resources in GSocket and Destroy_Socket() must be called even if
+ // the socket has never been opened, but if the allocation were done
+ // on demand, then Destroy_Socket() could be called from
+ // GSocket::Close() and we wouldn't need Close_Socket() at all
+ virtual void Close_Socket(GSocket *socket) = 0;
+
+ // undo Init_Socket(): called from GSocket dtor
+ virtual void Destroy_Socket(GSocket *socket) = 0;
+
+
+ // these functions enable or disable monitoring of the given socket for the
+ // specified events inside the currently running event loop (but notice
+ // that both BSD and Winsock implementations actually use socket->m_server
+ // value to determine what exactly should be monitored so it needs to be
+ // set before calling these functions)
+ virtual void Install_Callback(GSocket *socket,
+ GSocketEvent event = GSOCK_MAX_EVENT) = 0;
+ virtual void Uninstall_Callback(GSocket *socket,
+ GSocketEvent event = GSOCK_MAX_EVENT) = 0;
+
+ virtual ~GSocketManager() { }
+
+private:
+ // get the manager to use if we don't have it yet
+ static void Init();
+
+ static GSocketManager *ms_manager;
+};
+
+/*
+ Base class providing functionality common to BSD and Winsock sockets.
+
+ TODO: merge this in wxSocket itself, there is no reason to maintain the
+ separation between wxSocket and GSocket.
+ */
+class GSocketBase
+{
+public:
+ // static factory function: creates the low-level socket associated with
+ // the given wxSocket (and inherits its attributes such as timeout)
+ static GSocket *Create(wxSocketBase& wxsocket);
+
+ virtual ~GSocketBase();
+
+ void SetTimeout(unsigned long millisec);
+
+ GSocketError SetLocal(GAddress *address);
+ GSocketError SetPeer(GAddress *address);
+ GAddress *GetLocal();
+ GAddress *GetPeer();
+
+ GSocketEventFlags Select(GSocketEventFlags flags);
+
+ virtual GSocket *WaitConnection(wxSocketBase& wxsocket) = 0;
+
+ void Close();
+ virtual void Shutdown();
+
+ void SetInitialSocketBuffers(int recv, int send)
+ {
+ m_initialRecvBufferSize = recv;
+ m_initialSendBufferSize = send;
+ }
+
+ // notify m_wxsocket about the given socket event by calling its (inaptly
+ // named) OnRequest() method
+ void NotifyOnStateChange(GSocketEvent event);
+
+ // FIXME: making these functions virtual is a hack necessary to make the
+ // wxBase library link without requiring wxNet under Unix where
+ // GSocketSelectManager (part of wxBase) uses them, they don't
+ // really need to be virtual at all
+ virtual void Detected_Read() { }
+ virtual void Detected_Write() { }
+
+ // this is officially SOCKET (unsigned int) under Windows but we don't want
+ // to include winsock.h which defines SOCKET from here so just use int
+ // under all platforms
+ int m_fd;
+
+ int m_initialRecvBufferSize;
+ int m_initialSendBufferSize;
+
+ GAddress *m_local;
+ GAddress *m_peer;
+ GSocketError m_error;
+
+ bool m_non_blocking;
+ bool m_server;
+ bool m_stream;
+ bool m_establishing;
+ bool m_reusable;
+ bool m_broadcast;
+ bool m_dobind;
+
+ struct timeval m_timeout;
+
+ GSocketEventFlags m_detected;
+
+protected:
+ GSocketBase(wxSocketBase& wxsocket);
+
+private:
+ // set in ctor and never changed except that it's reset to NULL when the
+ // socket is shut down
+ wxSocketBase *m_wxsocket;
+
+ DECLARE_NO_COPY_CLASS(GSocketBase)
+};
+
+#if defined(__WINDOWS__)
+ #include "wx/msw/gsockmsw.h"
+#else
+ #include "wx/unix/gsockunx.h"
+#endif
+
+/* Global initializers */
+
+/* GSocket_Init() must be called at the beginning (but after calling
+ * GSocketManager::Set() if a custom manager should be used) */
+bool GSocket_Init();
+
+/* GSocket_Cleanup() must be called at the end */
+void GSocket_Cleanup();
+
+
+/* GAddress */
+
+// Represents a socket endpoint, i.e. -- in spite of its name -- not an address
+// but an (address, port) pair
+struct GAddress
+{
+ struct sockaddr *m_addr;
+ size_t m_len;
+
+ GAddressType m_family;
+ int m_realfamily;
+
+ GSocketError m_error;
+};
+
+GAddress *GAddress_new();
+GAddress *GAddress_copy(GAddress *address);
+void GAddress_destroy(GAddress *address);
+
+void GAddress_SetFamily(GAddress *address, GAddressType type);
+GAddressType GAddress_GetFamily(GAddress *address);
+
+/* The use of any of the next functions will set the address family to
+ * the specific one. For example if you use GAddress_INET_SetHostName,
+ * address family will be implicitly set to AF_INET.
+ */
+
+GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
+GSocketError GAddress_INET_SetBroadcastAddress(GAddress *address);
+GSocketError GAddress_INET_SetAnyAddress(GAddress *address);
+GSocketError GAddress_INET_SetHostAddress(GAddress *address,
+ unsigned long hostaddr);
+GSocketError GAddress_INET_SetPortName(GAddress *address, const char *port,
+ const char *protocol);
+GSocketError GAddress_INET_SetPort(GAddress *address, unsigned short port);
+
+GSocketError GAddress_INET_GetHostName(GAddress *address, char *hostname,
+ size_t sbuf);
+unsigned long GAddress_INET_GetHostAddress(GAddress *address);
+unsigned short GAddress_INET_GetPort(GAddress *address);
+
+GSocketError _GAddress_translate_from(GAddress *address,
+ struct sockaddr *addr, int len);
+GSocketError _GAddress_translate_to (GAddress *address,
+ struct sockaddr **addr, int *len);
+GSocketError _GAddress_Init_INET(GAddress *address);
+
+#if wxUSE_IPV6
+
+GSocketError GAddress_INET6_SetHostName(GAddress *address, const char *hostname);
+GSocketError GAddress_INET6_SetAnyAddress(GAddress *address);
+GSocketError GAddress_INET6_SetHostAddress(GAddress *address,
+ struct in6_addr hostaddr);
+GSocketError GAddress_INET6_SetPortName(GAddress *address, const char *port,
+ const char *protocol);
+GSocketError GAddress_INET6_SetPort(GAddress *address, unsigned short port);
+
+GSocketError GAddress_INET6_GetHostName(GAddress *address, char *hostname,
+ size_t sbuf);
+GSocketError GAddress_INET6_GetHostAddress(GAddress *address,struct in6_addr *hostaddr);
+unsigned short GAddress_INET6_GetPort(GAddress *address);
+
+#endif // wxUSE_IPV6
+
+// these functions are available under all platforms but only implemented under
+// Unix ones, elsewhere they just return GSOCK_INVADDR
+GSocketError _GAddress_Init_UNIX(GAddress *address);
+GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
+GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
+
+#endif /* wxUSE_SOCKETS */
+
+#endif /* _WX_PRIVATE_GSOCKET_H_ */
projects / wxWidgets.git / commitdiff
