1 | /* |
---|
2 | orxonox - the future of 3D-vertical-scrollers |
---|
3 | |
---|
4 | Copyright (C) 2004 orx |
---|
5 | |
---|
6 | This program is free software; you can redistribute it and/or modify |
---|
7 | it under the terms of the GNU General Public License as published by |
---|
8 | the Free Software Foundation; either version 2, or (at your option) |
---|
9 | any later version. |
---|
10 | |
---|
11 | ### File Specific: |
---|
12 | main-programmer: Patrick Boenzli |
---|
13 | co-programmer: ... |
---|
14 | */ |
---|
15 | |
---|
16 | |
---|
17 | /* this is for debug output. It just says, that all calls to PRINT() belong to the DEBUG_MODULE_NETWORK module |
---|
18 | For more information refere to https://www.orxonox.net/cgi-bin/trac.cgi/wiki/DebugOutput |
---|
19 | */ |
---|
20 | #define DEBUG_MODULE_NETWORK |
---|
21 | |
---|
22 | |
---|
23 | /* include your own header */ |
---|
24 | #include "network_manager.h" |
---|
25 | |
---|
26 | /* using namespace std is default, this needs to be here */ |
---|
27 | using namespace std; |
---|
28 | |
---|
29 | |
---|
30 | /************************************ |
---|
31 | What you will see here are the function definitions from the header file (network_manager.h) with doxygen documentation. Here is an example: |
---|
32 | |
---|
33 | |
---|
34 | In file network_manager.h |
---|
35 | |
---|
36 | class NetworkManager |
---|
37 | { |
---|
38 | int doSomeStuff(float argument, float* pointer); |
---|
39 | } |
---|
40 | |
---|
41 | will be implemented in the source file as follows: |
---|
42 | |
---|
43 | In file network_manager.cc |
---|
44 | |
---|
45 | / ** |
---|
46 | * this is the short description for this function: it just does some stuff |
---|
47 | * @param argument: this is the first argument, stuff... |
---|
48 | * @param pointer: this is the pointer to nowhereland |
---|
49 | * return: whatever the function returns: for example an index, number, etc. |
---|
50 | * / |
---|
51 | int NetworkManager::doSomeStuff(float argument, float* pointer) |
---|
52 | { |
---|
53 | // whaterver you want to do |
---|
54 | } |
---|
55 | |
---|
56 | |
---|
57 | if you want to make automake compile your files: you will want to add the file names to the local Makefile.am |
---|
58 | |
---|
59 | ************************************/ |
---|
60 | |
---|
61 | |
---|
62 | |
---|
63 | |
---|
64 | /** |
---|
65 | * standard constructor |
---|
66 | */ |
---|
67 | NetworkManager::NetworkManager() |
---|
68 | {} |
---|
69 | |
---|
70 | |
---|
71 | /** |
---|
72 | * standard deconstructor |
---|
73 | */ |
---|
74 | NetworkManager::~NetworkManager() |
---|
75 | {} |
---|
76 | |
---|
77 | |
---|
78 | /** |
---|
79 | * initializes the network manager |
---|
80 | */ |
---|
81 | void NetworkManager::initialize() |
---|
82 | {} |
---|
83 | |
---|
84 | |
---|
85 | /** |
---|
86 | * shutsdown the network manager |
---|
87 | */ |
---|
88 | void NetworkManager::shutdown() |
---|
89 | {} |
---|
90 | |
---|
91 | |
---|
92 | /** |
---|
93 | * creates a connection from one object to a host |
---|
94 | * @param address: the address of the destination host |
---|
95 | * @param synchronizeable: reference to the sync object |
---|
96 | */ |
---|
97 | void NetworkManager::establishConnection(/* address, port, object reference*/) |
---|
98 | {} |
---|
99 | |
---|
100 | |
---|
101 | /** |
---|
102 | * teardown a connection |
---|
103 | */ |
---|
104 | void NetworkManager::shutdownConnection() |
---|
105 | {} |
---|
106 | |
---|
107 | |
---|
108 | /** |
---|
109 | * registers a listener at the network manager |
---|
110 | * @param listener: the reference to the listener to be added |
---|
111 | */ |
---|
112 | void NetworkManager::registerListener(/* listener reference*/) |
---|
113 | {} |
---|
114 | |
---|
115 | /** |
---|
116 | * sync the network |
---|
117 | */ |
---|
118 | void NetworkManager::synchronize() |
---|
119 | {} |
---|
120 | |
---|
121 | |
---|