include/wx/sckint.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        sckint.h
   3 // Purpose:     Socket internal classes
   4 // Author:      Guilhem Lavaux
   5 // Modified by:
   6 // Created:     April 1999
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11 #ifndef _WX_NETWORK_SOCKET_INT_H
  12 #define _WX_NETWORK_SOCKET_INT_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #if wxUSE_SOCKETS
  19
  20 #include <wx/object.h>
  21 #include <wx/list.h>
  22 #include <wx/socket.h>
  23 #include <wx/thread.h>
  24
  25 // Socket state
  26 class SocketState
  27 {
  28  public:
  29   // TRUE if the background notifyier is on.
  30   bool notify_state;
  31   // Specifies which events we want to be notified.
  32   wxSocketBase::wxRequestNotify evt_notify_state;
  33   // Socket flags.
  34   wxSocketBase::wxSockFlags socket_flags;
  35   // Pointer to the C callback function.
  36   wxSocketBase::wxSockCbk c_callback;
  37   char *c_callback_data;
  38 };
  39
  40 // Socket request
  41 class SockRequest
  42 {
  43  public:
  44   // Buffer where to get/put data.
  45   char *buffer;
  46   // Size of the buffer.
  47   size_t size;
  48   // Number of bytes really read/written.
  49   size_t io_nbytes;
  50   // Error.
  51   unsigned int error;
  52   // Type of the request.
  53   wxSocketBase::wxRequestNotify type;
  54   // Timeout (in milliseconds).
  55   unsigned int timeout;
  56   // TRUE if the buffer has been processed.
  57   bool done;
  58   // TRUE if we must wait for the request completion, in the other case an
  59   // event will be sent to the main thread when the request is finished.
  60   bool wait;
  61 };
  62
  63 class wxSocketInternal;
  64 class SocketWaiter: public wxThread {
  65  public:
  66   SocketWaiter(wxSocketBase *socket, wxSocketInternal *internal);
  67   ~SocketWaiter();
  68
  69   // Thread Entry point
  70   // ---
  71   virtual void *Entry();
  72
  73  protected:
  74   void ProcessReadEvent();
  75   void ProcessWriteEvent();
  76
  77  public:
  78   wxSocketBase *m_socket;
  79   wxSocketInternal *m_internal;
  80   int m_fd;
  81 };
  82
  83 class SocketRequester: public wxThread {
  84  public:
  85   SocketRequester(wxSocketBase *socket, wxSocketInternal *internal);
  86   ~SocketRequester();
  87
  88   void ProcessWaitEvent(SockRequest *req);
  89   void ProcessReadEvent(SockRequest *req);
  90   void ProcessWriteEvent(SockRequest *req);
  91
  92   bool WaitFor(wxSocketBase::wxRequestNotify req, int millisec);
  93
  94   // Thread Entry point
  95   // ---
  96   virtual void *Entry();
  97
  98  public:
  99   wxSocketBase *m_socket;
 100   wxSocketInternal *m_internal;
 101   int m_fd;
 102 };
 103
 104 class wxSocketInternal {
 105  public:
 106   wxSocketInternal(wxSocketBase *socket);
 107   ~wxSocketInternal();
 108
 109   // wxSocket thread manager
 110   // -----------------------
 111   void AcquireData();
 112   void ReleaseData();
 113   void AcquireFD();
 114   void ReleaseFD();
 115
 116   int GetFD() { return m_fd; }
 117
 118   void InitializeSocket();
 119   void FinalizeSocket();
 120   void PauseSocket();
 121   void ResumeSocket();
 122   void EnableWaiter();
 123   void DisableWaiter();
 124
 125   void QueueRequest(SockRequest *request, bool async);
 126   void WaitForEnd(SockRequest *request);
 127
 128   SockRequest *WaitForReq();
 129   void EndRequest(SockRequest *req);
 130  public:
 131   wxMutex m_socket_locker, m_fd_locker, m_request_locker;
 132   wxCondition m_socket_cond;
 133   wxSocketBase *m_socket;
 134   SocketWaiter *m_thread_waiter;
 135   SocketRequester *m_thread_requester;
 136   wxList m_requests;
 137   int m_fd;
 138 };
 139
 140 #endif
 141   // wxUSE_SOCKETS
 142
 143 #endif
 144   // _WX_NETWORK_SOCKET_INT_H