Source/Base/Network/Socket/OSGDgramSocket.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 _DGRAMSOCKET_H_
  40 #define _DGRAMSOCKET_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 //---------------------------------------------------------------------------
  46 //  Includes
  47 //---------------------------------------------------------------------------
  48
  49 #include "OSGBaseDef.h"
  50 #include "OSGSocketException.h"
  51 #include "OSGSocketAddress.h"
  52 #include "OSGSocket.h"
  53
  54 OSG_BEGIN_NAMESPACE
  55
  56 class Dgram;
  57
  58 /*! \ingroup GrpBaseNetwork
  59     \ingroup GrpBaseNetworkSockets
  60     \ingroup GrpLibOSGBase
  61  */
  62
  63 class OSG_BASE_DLLMAPPING DgramSocket:public Socket
  64 {
  65     /*==========================  PUBLIC  =================================*/
  66   public:
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                   Constructors                               */
  70     /*! \{                                                                 */
  71
  72     DgramSocket();
  73     DgramSocket(const DgramSocket &source);
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                   open/close                                 */
  78     /*! \{                                                                 */
  79
  80     virtual void open (void);
  81     virtual void close(void);
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                   read, write                                */
  86     /*! \{                                                                 */
  87
  88     int recvFromRaw(      void           *buf ,
  89                           int             size,
  90                           SocketAddress  &from );
  91
  92     int recvFrom   (      Dgram          &buf ,
  93                           SocketAddress  &from );
  94     int peekFrom   (      void           *buf ,
  95                           int             size,
  96                           SocketAddress  &from );
  97     int recvFrom   (      NetworkMessage &msg ,
  98                           SocketAddress  &from );
  99     int sendTo     (const void           *buf ,
 100                           int             size,
 101                     const SocketAddress  &to   );
 102     int sendTo     (      NetworkMessage &msg ,
 103                     const SocketAddress  &to   );
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                multicast                                     */
 108     /*! \{                                                                 */
 109
 110     void join             (const SocketAddress &group,
 111                            const SocketAddress &interf=
 112                                  SocketAddress(SocketAddress::ANY));
 113     void leave            (const SocketAddress &group,
 114                            const SocketAddress &interf=
 115                                  SocketAddress(SocketAddress::ANY));
 116     void setTTL           (      unsigned char ttl                );
 117     void setMCastInterface(const SocketAddress &interf            );
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                   assignment                                 */
 122     /*! \{                                                                 */
 123
 124         const DgramSocket & operator =(const DgramSocket &source);
 125
 126     /*! \}                                                                 */
 127
 128     /*=========================  PROTECTED  ===============================*/
 129   protected:
 130
 131     /*==========================  PRIVATE  ================================*/
 132   private:
 133
 134     typedef Socket Inherited;
 135 };
 136
 137 OSG_END_NAMESPACE
 138
 139 #endif