Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/network/NetworkPrereqs.h @ 9246

Last change on this file since 9246 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 4.8 KB
RevLine 
[1168]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
[1232]3 *                    > www.orxonox.net <
[1168]4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
[5929]30@file
31@brief
32    Shared library macros, enums, constants and forward declarations for the network library
[1168]33*/
34
35#ifndef _NetworkPrereqs_H__
36#define _NetworkPrereqs_H__
37
[2710]38#include "OrxonoxConfig.h"
[1168]39
40//-----------------------------------------------------------------------
41// Shared library settings
42//-----------------------------------------------------------------------
[5929]43
[2710]44#if defined(ORXONOX_PLATFORM_WINDOWS) && !defined( NETWORK_STATIC_BUILD )
[1168]45#  ifdef NETWORK_SHARED_BUILD
46#    define _NetworkExport __declspec(dllexport)
47#  else
48#    if defined( __MINGW32__ )
49#      define _NetworkExport
50#    else
51#      define _NetworkExport __declspec(dllimport)
52#    endif
53#  endif
[8351]54#  define _NetworkPrivate
55#elif defined (ORXONOX_GCC_VISIBILITY)
[1168]56#  define _NetworkExport  __attribute__ ((visibility("default")))
[8351]57#  define _NetworkPrivate __attribute__ ((visibility("hidden")))
[1168]58#else
59#  define _NetworkExport
[8351]60#  define _NetworkPrivate
[1168]61#endif
62
[1360]63//-----------------------------------------------------------------------
[5929]64// Constants
[2662]65//-----------------------------------------------------------------------
[5929]66
[2662]67namespace orxonox
68{
[7801]69  static const unsigned int GAMESTATEID_INITIAL       = static_cast<unsigned int>(-1);
[7163]70  extern const char* LAN_DISCOVERY_MESSAGE;
71  extern const char* LAN_DISCOVERY_ACK;
[7801]72  static const unsigned int LAN_DISCOVERY_PORT          = 55558;
73  static const unsigned int NETWORK_PEER_ID_SERVER      = 0;
[8327]74  static const unsigned int NETWORK_PEER_ID_BROADCAST   = static_cast<unsigned int>(-1);
75  static const unsigned int NETWORK_PEER_ID_UNKNOWN     = static_cast<unsigned int>(-2);
[7801]76  static const unsigned int NETWORK_CHANNEL_DEFAULT     = 0;
77  static const unsigned int NETWORK_CHANNEL_UNRELIABLE  = 1;
78  static const unsigned int NETWORK_CHANNEL_COUNT       = 2;
[2662]79}
80
81//-----------------------------------------------------------------------
[5929]82// Enums
83//-----------------------------------------------------------------------
84
85namespace orxonox
86{
87  namespace packet
88  {
89    namespace PacketFlag
90    {
91      enum Value
92      {
[7801]93        Reliable    = 1,
94        Unsequenced = 2,
95        NoAllocate  = 4
[5929]96      };
97    }
98  }
99}
100
101//-----------------------------------------------------------------------
[1168]102// Forward declarations
103//-----------------------------------------------------------------------
[2773]104
105// from ENet
106struct _ENetPeer;
[7801]107typedef _ENetPeer     ENetPeer;
[2773]108struct _ENetPacket;
[7801]109typedef _ENetPacket   ENetPacket;
[2773]110struct _ENetEvent;
[7801]111typedef _ENetEvent    ENetEvent;
[2773]112struct _ENetHost;
[7801]113typedef _ENetHost     ENetHost;
[2773]114struct _ENetAddress;
[7801]115typedef _ENetAddress  ENetAddress;
116typedef uint8_t       ENetChannelID;
[2773]117
[2171]118namespace orxonox
[1168]119{
120  class Client;
121  class ClientConnection;
[2087]122  class ClientConnectionListener;
[1168]123  class ClientInformation;
[3214]124  class Connection;
[7490]125  class FunctionCall;
[3084]126  class FunctionCallManager;
[1735]127  class GamestateClient;
[5929]128  class GamestateHandler;
[1735]129  class GamestateManager;
[5929]130  class Host;
[8858]131  class MasterServer;
132  class MasterServerComm;
133  class NetworkChatListener;
[3084]134  class NetworkFunctionBase;
[5929]135  struct NetworkFunctionPointer;
[3084]136  class NetworkFunctionStatic;
[5929]137  template <class T>
138  class NetworkMemberFunction;
[3084]139  class NetworkMemberFunctionBase;
[8858]140  class PeerList;
[1168]141  class Server;
[3214]142  class ServerConnection;
143  class TrafficControl;
[8858]144  class WANDiscoverable;
145  class WANDiscovery;
[2662]146
[5929]147  // packet
[2662]148  namespace packet
149  {
[3084]150    class Acknowledgement;
151    class Chat;
152    class ClassID;
[5929]153    class DeleteObjects;
[3084]154    class FunctionCalls;
155    class FunctionIDs;
[1735]156    class Gamestate;
157    class Packet;
158    class Welcome;
[5929]159  }
[3214]160
[5929]161  // synchronisable
162  template <class T>
163  class NetworkCallback;
[6417]164  template <class T, class U>
165  class NetworkCallbackNotify;
[5929]166  class NetworkCallbackBase;
167  class NetworkCallbackManager;
168  class Synchronisable;
169  class SynchronisableHeader;
170  template <class T>
171  class SynchronisableVariable;
172  class SynchronisableVariableBase;
173  template <class T>
174  class SynchronisableVariableBidirectional;
[1168]175}
176
[7801]177namespace boost
178{
179  class mutex;
180  class thread;
181}
182
[1168]183#endif /* _NetworkPrereqs_H__ */
Note: See TracBrowser for help on using the repository browser.