Source/Base/Network/Socket/OSGDgramQueue.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _DGRAMQUEUE_H_
  40 #define _DGRAMQUEUE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include <list>
  46
  47 #include "OSGBaseTypes.h"
  48 #include "OSGTime.h"
  49 #include "OSGBaseDef.h"
  50 #include "OSGConnection.h"
  51 #include "OSGDgramSocket.h"
  52 #include "OSGSocketAddress.h"
  53 #include "OSGConnectionType.h"
  54 #include "OSGDgram.h"
  55 #include "OSGBarrier.h"
  56
  57 OSG_BEGIN_NAMESPACE
  58
  59 class BaseThread;
  60
  61 /*! \ingroup GrpBaseNetwork
  62     \ingroup GrpBaseNetworkSockets
  63     \ingroup GrpLibOSGBase
  64     \nohierarchy
  65  */
  66
  67 class OSG_BASE_DLLMAPPING DgramQueue
  68 {
  69     /*==========================  PUBLIC  =================================*/
  70
  71   public:
  72
  73     typedef std::list<Dgram*>          QueueT;
  74
  75     /*---------------------------------------------------------------------*/
  76     /*! \name                   Constructors                               */
  77     /*! \{                                                                 */
  78
  79     DgramQueue(void);
  80
  81     /*! \}                                                                 */
  82     /*---------------------------------------------------------------------*/
  83     /*! \name                   Destructor                                 */
  84     /*! \{                                                                 */
  85
  86     virtual ~DgramQueue(void);
  87
  88     /*! \}                                                                 */
  89     /*---------------------------------------------------------------------*/
  90     /*! \name               data put,get                                   */
  91     /*! \{                                                                 */
  92
  93     void   put    (Dgram *dgram);
  94     Dgram *get    (Lock  *lock );
  95     bool   empty  (void        );
  96     void   wait   (Lock  *lock );
  97     bool   waiting(void        );
  98
  99     /*! \}                                                                 */
 100     /*=========================  PROTECTED  ===============================*/
 101
 102   protected:
 103
 104     /*---------------------------------------------------------------------*/
 105     /*! \name               member                                         */
 106     /*! \{                                                                 */
 107
 108     BarrierRefPtr _barrier;
 109     QueueT        _queue;
 110     bool          _waiting;
 111
 112     /*! \}                                                                 */
 113     /*==========================  PRIVATE  ================================*/
 114
 115   private:
 116
 117         /*!\brief prohibit default function (move to 'public' if needed) */
 118     DgramQueue(const DgramQueue &source);
 119     void operator =(const DgramQueue &source);
 120 };
 121
 122 // class pointer
 123 typedef DgramQueue *DgramQueueP;
 124
 125 OSG_END_NAMESPACE
 126
 127 #endif /* _DGRAMQUEUE_H_ */