Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 9342 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
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
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/**
30@file
31@brief
32    Shared library macros, enums, constants and forward declarations for the network library
33*/
34
35#ifndef _NetworkPrereqs_H__
36#define _NetworkPrereqs_H__
37
38#include "OrxonoxConfig.h"
39
40//-----------------------------------------------------------------------
41// Shared library settings
42//-----------------------------------------------------------------------
43
44#if defined(ORXONOX_PLATFORM_WINDOWS) && !defined( NETWORK_STATIC_BUILD )
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
54#  define _NetworkPrivate
55#elif defined (ORXONOX_GCC_VISIBILITY)
56#  define _NetworkExport  __attribute__ ((visibility("default")))
57#  define _NetworkPrivate __attribute__ ((visibility("hidden")))
58#else
59#  define _NetworkExport
60#  define _NetworkPrivate
61#endif
62
63//-----------------------------------------------------------------------
64// Constants
65//-----------------------------------------------------------------------
66
67namespace orxonox
68{
69  static const unsigned int GAMESTATEID_INITIAL       = static_cast<unsigned int>(-1);
70  extern const char* LAN_DISCOVERY_MESSAGE;
71  extern const char* LAN_DISCOVERY_ACK;
72  static const unsigned int LAN_DISCOVERY_PORT          = 55558;
73  static const unsigned int NETWORK_PEER_ID_SERVER      = 0;
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);
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;
79}
80
81//-----------------------------------------------------------------------
82// Enums
83//-----------------------------------------------------------------------
84
85namespace orxonox
86{
87  namespace packet
88  {
89    namespace PacketFlag
90    {
91      enum Value
92      {
93        Reliable    = 1,
94        Unsequenced = 2,
95        NoAllocate  = 4
96      };
97    }
98  }
99}
100
101//-----------------------------------------------------------------------
102// Forward declarations
103//-----------------------------------------------------------------------
104
105// from ENet
106struct _ENetPeer;
107typedef _ENetPeer     ENetPeer;
108struct _ENetPacket;
109typedef _ENetPacket   ENetPacket;
110struct _ENetEvent;
111typedef _ENetEvent    ENetEvent;
112struct _ENetHost;
113typedef _ENetHost     ENetHost;
114struct _ENetAddress;
115typedef _ENetAddress  ENetAddress;
116typedef uint8_t       ENetChannelID;
117
118namespace orxonox
119{
120  class Client;
121  class ClientConnection;
122  class ClientConnectionListener;
123  class ClientInformation;
124  class Connection;
125  class FunctionCall;
126  class FunctionCallManager;
127  class GamestateClient;
128  class GamestateHandler;
129  class GamestateManager;
130  class Host;
131  class MasterServer;
132  class MasterServerComm;
133  class NetworkChatListener;
134  class NetworkFunctionBase;
135  struct NetworkFunctionPointer;
136  class NetworkFunctionStatic;
137  template <class T>
138  class NetworkMemberFunction;
139  class NetworkMemberFunctionBase;
140  class PeerList;
141  class Server;
142  class ServerConnection;
143  class TrafficControl;
144  class WANDiscoverable;
145  class WANDiscovery;
146
147  // packet
148  namespace packet
149  {
150    class Acknowledgement;
151    class Chat;
152    class ClassID;
153    class DeleteObjects;
154    class FunctionCalls;
155    class FunctionIDs;
156    class Gamestate;
157    class Packet;
158    class Welcome;
159  }
160
161  // synchronisable
162  template <class T>
163  class NetworkCallback;
164  template <class T, class U>
165  class NetworkCallbackNotify;
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;
175}
176
177namespace boost
178{
179  class mutex;
180  class thread;
181}
182
183#endif /* _NetworkPrereqs_H__ */
Note: See TracBrowser for help on using the repository browser.