[5530] | 1 | /* |
---|
[5520] | 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 | |
---|
[5525] | 17 | /* this is for debug output. It just says, that all calls to PRINT() belong to the DEBUG_MODULE_NETWORK module |
---|
[5530] | 18 | For more information refere to https://www.orxonox.net/cgi-bin/trac.cgi/wiki/DebugOutput |
---|
[5525] | 19 | */ |
---|
[5530] | 20 | #define DEBUG_MODULE_NETWORK |
---|
[5525] | 21 | |
---|
| 22 | |
---|
| 23 | /* include your own header */ |
---|
[5520] | 24 | #include "network_manager.h" |
---|
| 25 | |
---|
[5530] | 26 | /* include this file, it contains some default definitions */ |
---|
| 27 | #include "netdefs.h" |
---|
| 28 | |
---|
[5525] | 29 | /* using namespace std is default, this needs to be here */ |
---|
[5520] | 30 | using namespace std; |
---|
| 31 | |
---|
| 32 | |
---|
[5525] | 33 | /************************************ |
---|
| 34 | What you will see here are the function definitions from the header file (network_manager.h) with doxygen documentation. Here is an example: |
---|
[5520] | 35 | |
---|
[5530] | 36 | |
---|
| 37 | In file network_manager.h |
---|
| 38 | |
---|
[5525] | 39 | class NetworkManager |
---|
| 40 | { |
---|
| 41 | int doSomeStuff(float argument, float* pointer); |
---|
[5530] | 42 | } |
---|
[5520] | 43 | |
---|
[5525] | 44 | will be implemented in the source file as follows: |
---|
| 45 | |
---|
| 46 | In file network_manager.cc |
---|
| 47 | |
---|
| 48 | / ** |
---|
| 49 | * this is the short description for this function: it just does some stuff |
---|
| 50 | * @param argument: this is the first argument, stuff... |
---|
[5530] | 51 | * @param pointer: this is the pointer to nowhereland |
---|
| 52 | * return: whatever the function returns: for example an index, number, etc. |
---|
| 53 | * / |
---|
[5525] | 54 | int NetworkManager::doSomeStuff(float argument, float* pointer) |
---|
| 55 | { |
---|
[5530] | 56 | // whaterver you want to do |
---|
| 57 | } |
---|
[5525] | 58 | |
---|
[5530] | 59 | |
---|
[5525] | 60 | if you want to make automake compile your files: you will want to add the file names to the local Makefile.am |
---|
[5530] | 61 | |
---|
[5525] | 62 | ************************************/ |
---|
| 63 | |
---|
[5530] | 64 | |
---|
| 65 | |
---|
| 66 | |
---|
[5520] | 67 | /** |
---|
| 68 | * standard constructor |
---|
| 69 | */ |
---|
| 70 | NetworkManager::NetworkManager() |
---|
| 71 | {} |
---|
| 72 | |
---|
| 73 | |
---|
| 74 | /** |
---|
| 75 | * standard deconstructor |
---|
| 76 | */ |
---|
| 77 | NetworkManager::~NetworkManager() |
---|
| 78 | {} |
---|
| 79 | |
---|
[5522] | 80 | |
---|
| 81 | /** |
---|
| 82 | * initializes the network manager |
---|
| 83 | */ |
---|
| 84 | void NetworkManager::initialize() |
---|
| 85 | {} |
---|
| 86 | |
---|
[5530] | 87 | |
---|
[5522] | 88 | /** |
---|
| 89 | * shutsdown the network manager |
---|
| 90 | */ |
---|
| 91 | void NetworkManager::shutdown() |
---|
| 92 | {} |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | /** |
---|
| 96 | * creates a connection from one object to a host |
---|
| 97 | * @param address: the address of the destination host |
---|
| 98 | * @param synchronizeable: reference to the sync object |
---|
| 99 | */ |
---|
[5525] | 100 | void NetworkManager::establishConnection(/* address, port, object reference*/) |
---|
[5522] | 101 | {} |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | /** |
---|
| 105 | * teardown a connection |
---|
| 106 | */ |
---|
| 107 | void NetworkManager::shutdownConnection() |
---|
| 108 | {} |
---|
| 109 | |
---|
[5530] | 110 | |
---|
[5522] | 111 | /** |
---|
| 112 | * registers a listener at the network manager |
---|
| 113 | * @param listener: the reference to the listener to be added |
---|
| 114 | */ |
---|
[5525] | 115 | void NetworkManager::registerListener(/* listener reference*/) |
---|
[5522] | 116 | {} |
---|
| 117 | |
---|
| 118 | /** |
---|
| 119 | * sync the network |
---|
| 120 | */ |
---|
| 121 | void NetworkManager::synchronize() |
---|
| 122 | {} |
---|
| 123 | |
---|
| 124 | |
---|