engine/include/network/BroadcastClient.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 _BROADCASTCLIENT_H_
  23 #define _BROADCASTCLIENT_H_
  24
  25 #include <enet/enet.h>
  26 #include <string>
  27 #include <vector>
  28
  29 #include "core/Address.h"
  30
  31 //tolua_begin
  32 namespace peak
  33 {
  34         class Script;
  35
  36         /**
  37          * \brief Socket which sends broadcast messages at a fixed interval to get the
  38          * address of local network servers.
  39          */
  40         class BroadcastClient
  41         {
  42                 public:
  43                         BroadcastClient();
  44                         ~BroadcastClient();
  45
  46                         /**
  47                          * \brief Starts broadcasting.
  48                          * \param port Port to send messages at
  49                          */
  50                         void start(int port);
  51                         /**
  52                          * \brief Stops broadcasting
  53                          */
  54                         void stop(void);
  55
  56                         /**
  57                          * \brief Clears server list.
  58                          */
  59                         void clearList(void);
  60
  61                         /**
  62                          * \brief Returns the number of found servers.
  63                          */
  64                         int getServerCount(void);
  65                         /**
  66                          * \brief Returns the server info of one server.
  67                          * \param index Index of the server, can be in the range 0..getServerCount().
  68                          * \return Server reply
  69                          */
  70                         std::string getServerInfo(int index);
  71                         /**
  72                          * \brief Returns the address of one server.
  73                          * \param index Index of the server, can be in the range 0..getServerCount().
  74                          * \return Server address
  75                          */
  76                         Address getServerAddress(int index);
  77
  78                         /**
  79                          * \brief Sets a callback function which gets called everytime the
  80                          * server list changes.
  81                          * \param script Lua script which defines the function
  82                          * \param function Function to call
  83                          */
  84                         void setCallback(Script *script, std::string function);
  85
  86                         /**
  87                          * \brief Sends a broadcast message if needed, handles incoming responses.
  88                          * \param msecs Passed time since last call of this function
  89                          */
  90                         void doWork(float msecs = 0);
  91
  92                         /**
  93                          * \brief Updates all broadcast clients.
  94                          * \param msecs Passed time since last call of this function
  95                          */
  96                         static void doAllWork(float msecs);
  97                 private:
  98                         //tolua_end
  99                         ENetSocket socket;
 100                         int port;
 101
 102                         float updatetime;
 103
 104                         Script *cbscript;
 105                         std::string cbfunc;
 106
 107                         std::vector<std::string> serverinfo;
 108                         std::vector<Address> serveraddr;
 109
 110                         static std::vector<BroadcastClient*> bcclients;
 111                         //tolua_begin
 112         };
 113 }
 114 //tolua_end
 115
 116 #endif
 117