| 1 | |
|---|
| 2 | |
|---|
| 3 | This readme just gives some hints for the general network programming: |
|---|
| 4 | |
|---|
| 5 | ARCHITECTURE: |
|---|
| 6 | The NetworkStream is in the center of this structure. |
|---|
| 7 | |
|---|
| 8 | |
|---|
| 9 | UserId: |
|---|
| 10 | ======= |
|---|
| 11 | containing 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 | |
|---|
| 13 | the 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 | |
|---|
| 15 | There are some reserved id's, don't mess with them: |
|---|
| 16 | 0 : Master Server |
|---|
| 17 | 1 : First Proxy Server |
|---|
| 18 | 2 : Second Proxy Server |
|---|
| 19 | 3 : Third Proxy Server |
|---|
| 20 | 4 : Fourth Proxy Server |
|---|
| 21 | . |
|---|
| 22 | . |
|---|
| 23 | . |
|---|
| 24 | NET_MAX_PROXY The maximal number of proxy servers |
|---|
| 25 | NET_MAX... + 1 First Client |
|---|
| 26 | NET_MAX... + 2 Second Client |
|---|
| 27 | . |
|---|
| 28 | . |
|---|
| 29 | . |
|---|
| 30 | NET_MAX_CONNECTION Last client |
|---|
| 31 | |
|---|
| 32 | The 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 | |
|---|
| 36 | uniqueId: |
|---|
| 37 | ========= |
|---|
| 38 | uniqueId 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 | |
|---|
| 41 | permissions: |
|---|
| 42 | ============ |
|---|
| 43 | Each synchronizeable variable has some write permissions. this permission systems allows to manage which network nodes are able to write the variables. |
|---|
| 44 | PERMISSION_MASTER_SERVER : only the master server can write this variable |
|---|
| 45 | PERMISSION_PROXY_SERVER : only the proxy server can write this variable |
|---|
| 46 | PERMISSION_OWNER : only the owner can write this variable |
|---|
| 47 | PERMISSION_ALL : all clients can write this variable |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | |
|---|
| 52 | |
|---|
| 53 | NetworkStream PeerInfo list: (peers) |
|---|
| 54 | ===================================== |
|---|
| 55 | The 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). |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | UNSOLVED: |
|---|
| 61 | ========= |
|---|
| 62 | - what if the proxy server gets a new client and wants to add it to the game? There are some problems waiting in the network game manager |
|---|
| 63 | - actualy the whole message sending system won't work in this network topic. proxys have to relay messages to clients |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | |
|---|
