Networking Sample

To start a server, use network.startServer(). Here, we will set the maximum number of client connections to 10. When this limit is reached, new connection requests are rejected.
But before that, we need to create an instance of NetworkAddress to store and pass our server address over the network.

// Create NetworkAddress instance. Assign its ownership to the script (to be handled by a garbage collector).
NetworkAddress server_address = class_manage(new NetworkAddress("127.0.0.1",60016));

// Start a server. No more than 10 clients can connect to it.
network.startServer(server_address,10);

To stop the server, use network.stopServer().

network.stopServer();

To connect a client to the server, use network.connectToServer() and pass the server address (a NetworkAddress instance).

network.connectToServer(server_address);

To disconnect from the server, use network.disconnectFromServer().

network.disconnectFromServer();

To create a state from the array of data fields, use network.createSharedState() function.

SharedState state = network.createSharedState(owner_id,state_id,(field0,field1,field2));

You can also create an empty state and fill it with data. It can be done in different ways.

// Create an empty state
SharedState state = network.createSharedState(owner_id,state_id);

// Fill the state with data:
// from the array
state.setArray((field0,field1,field2));

// field by field
state.addDataField(field0);
state.addDataField(field1);
state.addDataField(field2);

state.setDataField(0,field0);
state.setDataField(1,field1);
state.setDataField(2,field2);

// if there is only one field
state.setDataField(field);

state.setNextDataField(field0);
state.setNextDataField(field1);
state.setNextDataField(field2);

// from the existing instance of SharedData
state.setData(data);

Set state synchronization parameters:

• update interval — how often state updates will be sent
• update reliability — how reliable you want packet delivery to be
• state relevance — whether all updates should be sent to the network node, some of them or none at all
• history size — how much updates will be stored for this state

state.setUpdateInterval(100);
state.setReliability(RT_RELIABLE_ORDERED);
state.setRelevantState(user.getNetworkAddress(),RELEVANT_STATE_SEND_ALL_CHANGES)
state.setMaxHistorySize(20);

You can also disable the automatic sending of updates (via setAutoUpdate()) and send the state updates manually (via network.sendUpdateSharedState()). In this case, it makes no sense to set update interval.

// Set state synchronization parameters
state.setReliability(RT_RELIABLE_ORDERED);
state.setRelevantState(user.getNetworkAddress(),RELEVANT_STATE_SEND_ALL_CHANGES)
state.setMaxHistorySize(20);
// Send state update
network.sendUpdateSharedState(state);

A state should be deleted by the same network host that called its creation function.

network.destroySharedState(state);

A state can be updated using any of the methods described above.

To access the last update of the state and get its timestamp, use getSharedData() and getTimestamp() functions.

SharedData server_data = state.getSharedData();
int timestamp = state.getTimestamp();

forloop(int i = 0; state.getNumDataFields()) {
    log.message("field %d : %s\n",i,string(state.getDataField(i)));
}

// or
state.resetCurDataField();
forloop(int i = 0; state.getNumDataFields()) {
    log.message("field %d %s\n",i,string(state.getNextDataField()));
} 

Even if there is only one field in the container, you can still use getDataField():

int field = state.getDataField();

A state can automatically store the history of updates received from another network node. (Only if the maximum size for history is set higher than 1!) To work with this update history, do the following.

forloop(int i = 0; state.getHistorySize()) {
    int timestamp = state.getTimestamp(i);
    SharedData data = state.getHistoryEntry(i);
} 

1. On the server side, you need to set the game_type_info. By this information clients will find necessary servers in the LAN and filter out all the rest. In addition, you can set any custom_info that the server will send back in response (for example, the current number of connected clients).
   Source code (UnigineScript)

   network.setGameTypeInfo("sample");
   network.setCustomInfo("0");
   

2. Start the server on the specified address.
   Source code (UnigineScript)

   network.startServer(server_address,10);
   

1. Set the game_type_info in order to connect to the desired server.
   Source code (UnigineScript)

   network.setGameTypeInfo("sample");
   

2. Register and implement event handler NETWORK_ON_PONG_RECEIVED. This message indicates that the server has replied to a connection request.
   Source code (UnigineScript)

   network.registerHandler(NETWORK_ON_PONG_RECEIVED,"NetworkHandler::onPongReceived");
   
   void onPongReceived(NetworkAddress server_address,int ping_time,string game_type,string custom_info) {		
   	log.message("New server available: address = %s ping = %d ms game type = %s number of clients = %s\n",
   server_address.toString(),ping_time,game_type,custom_info);
   }
   

3. Send the ping request if there are game servers in the LAN.
   Source code (UnigineScript)

   // To search for the servers filtered according to game_type_info
   network.pingAvailableLANServers(listen_port,server_port,"sample")
   // To search for all servers
   network.pingAvailableLANServers(listen_port,server_port,"")