Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/proxy/src/lib/network/README.NETWORK @ 9464

Last change on this file since 9464 was 9459, checked in by patrick, 18 years ago

deep framework switch to enable differentiation of proxy/client network connection attempts

File size: 2.1 KB
Line 
1
2
3This readme just gives some hints for the general network programming:
4
5ARCHITECTURE:
6The NetworkStream is in the center of this structure.
7
8
9UserId:
10=======
11containing the id of a user (==client). This id must be unique within a orxonox network its used especialy in the NetworkStream for node identification and also in the Synchronizeable base class for permissions checking (PERMISSION_OWNER)
12
13the connections belonging tu toe userId's are stored in the NetworkStream::peers std::map. As a keyvalue the userId's are used. Therefore the usage of this peers map is very delicate. Don't ever try to add anything you are not sure about the id stuff.
14
15There are some reserved id's, don't mess with them:
160 :                  Master Server
171 :                  First Proxy Server
182 :                  Second Proxy Server
193 :                  Third Proxy Server
204 :                  Fourth Proxy Server
21.
22.
23.
24NET_MAX_PROXY        The maximal number of proxy servers
25NET_MAX... + 1       First Client
26NET_MAX... + 2       Second Client
27.
28.
29.
30NET_MAX_CONNECTION   Last client
31
32The proxy server ids are assigned as stated in the data/trunk/config/network_settings.conf, the first proxy server in the list gets the id NET_ID_PROXY_01 and so on.
33
34
35
36uniqueId:
37=========
38uniqueId is an id (unique :D) for each synchronizeable to be identified in a network. the number space for uniqueIds goes from 0 to maxplayers - 1
39
40
41permissions:
42============
43Each synchronizeable variable has some write permissions. this permission systems allows to manage which network nodes are able to write the variables.
44PERMISSION_MASTER_SERVER       : only the master server can write this variable
45PERMISSION_PROXY_SERVER        : only the proxy server can write this variable
46PERMISSION_OWNER               : only the owner can write this variable
47PERMISSION_ALL                 : all clients can write this variable
48
49
50
51
52
53NetworkStream PeerInfo list: (peers)
54=====================================
55The network node with the offset 0 is always the server to which the client must connect to (in case there are connections to other hosts at the same time).
Note: See TracBrowser for help on using the repository browser.