Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 5525 in orxonox.OLD for branches/network/src


Ignore:
Timestamp:
Nov 9, 2005, 5:17:27 PM (19 years ago)
Author:
patrick
Message:

network/lib/network: some help added to the network manager

Location:
branches/network/src/lib/network
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/network/src/lib/network/network_manager.cc

    r5522 r5525  
    1414*/
    1515
    16 #define DEBUG_SPECIAL_MODULE DEBUG_MODULE_NETWORK
    1716
     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 */
    1824#include "network_manager.h"
    1925
     26/* using namespace std is default, this needs to be here */
    2027using namespace std;
    2128
    2229
     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 
    2335
     36 class NetworkManager
     37 {
     38   int doSomeStuff(float argument, float* pointer);
     39 }   
    2440
     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               
    2564/**
    2665 *  standard constructor
     
    5695 * @param synchronizeable: reference to the sync object
    5796 */
    58 void NetworkManager::establishConnection()
     97void NetworkManager::establishConnection(/* address, port, object reference*/)
    5998{}
    6099
     
    71110 * @param listener: the reference to the listener to be added
    72111 */
    73 void NetworkManager::registerListener()
     112void NetworkManager::registerListener(/* listener reference*/)
    74113{}
    75114
  • branches/network/src/lib/network/network_manager.h

    r5522 r5525  
    2121 
    2222  void initialize();
    23   void sthudown();
    24   void establishConnection();
     23  void shutdown();
     24  void establishConnection(/* address, port, object reference*/);
    2525  void shutdownConnection();
    2626 
Note: See TracChangeset for help on using the changeset viewer.