engine/include/network/BroadcastHost.h

   1 /*
   2 Copyright (C) 2008  Mathias Gottschlag
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy of
   5 this software and associated documentation files (the "Software"), to deal in the
   6 Software without restriction, including without limitation the rights to use,
   7 copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
   8 Software, and to permit persons to whom the Software is furnished to do so,
   9 subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all
  12 copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  15 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  16 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  17 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  18 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  19 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20 */
  21
  22 #ifndef _BROADCASTHOST_H_
  23 #define _BROADCASTHOST_H_
  24
  25 #include <enet/enet.h>
  26 #include <string>
  27
  28 //tolua_begin
  29 namespace peak
  30 {
  31         /**
  32          * \brief Socket which automatically replies to broadcast messages.
  33          */
  34         class BroadcastHost
  35         {
  36                 public:
  37                         BroadcastHost();
  38                         ~BroadcastHost();
  39
  40                         /**
  41                          * \brief Initializes the broadcast host.
  42                          * \param port Port on which the socket listens
  43                          */
  44                         bool init(int port);
  45                         /**
  46                          * \brief Destroys the broadcast host.
  47                          */
  48                         bool shutdown(void);
  49
  50                         /**
  51                          * \brief Sets the reply of the broadcast host.
  52                          * \param info Reply string
  53                          */
  54                         void setInfo(std::string info);
  55                         /**
  56                          * \brief Returns the used reply string.
  57                          */
  58                         std::string getInfo(void);
  59
  60                         /**
  61                          * \brief Listens for incoming data and sends replies.
  62                          */
  63                         void doWork(void);
  64                 private:
  65                         //tolua_end
  66                         ENetSocket bcastsocket;
  67
  68                         std::string info;
  69                         //tolua_begin
  70         };
  71 }
  72 //tolua_end
  73
  74 #endif
  75