NorthBound#

network_gym_client.NorthBound#

class network_gym_client.NorthBoundClient(id, config_json)[source]#

NetworkGym northbound interface client.

Northbound interface connects the network gym client to the network gym server. Client sends the network policy to the Sever/Env. Sever/Env replies the network stats to the Client.

Initialize NorthBoundClient.

Parameters:
  • id (int) – client ID

  • config_json (json) – configuration file

Methods#

network_gym_client.NorthBoundClient.connect(self)#

Connect to the network gym server. Send the Start Env request, where the configuration is loaded from json file.

network_gym_client.NorthBoundClient.send(self, policy)#

Send the Policy to the server and environment.

Parameters:

policy (json) – network policy

network_gym_client.NorthBoundClient.recv(self)#

Receive a message from the network gym server.

Returns:

pd.DataFrame – the network stats measurement from the environment

Additional Methods#

network_gym_client.NorthBoundClient.process_measurement(self, reply_json)#

Process the measurement.

Parameters:

reply_json (json) – the network stats measurement

Returns:

pd.DataFrame – the processed network stats measurement