| 20 | |
| 21 | == Sample Experiment Setup Using API == |
| 22 | |
| 23 | A sample usage of the API for experiment setup is as shown in the Figure below. |
| 24 | |
| 25 | As shown in the figure, the most basic tasks involve two operations: |
| 26 | 1. Requesting the slice manager to create and start the slice – [wiki:Internal/WiMAX/WiMAXAPI/SliceMgmt#createSLICE createSlice()] |
| 27 | 2. Adding a mobile client to the slice through the [wiki:Internal/WiMAX/WiMAXAPI/SliceMgmt#addClient() addClient() call]. |
| 28 | |
| 29 | On the completion of these two API and after the client registers with the system, the slice manager service should inform the Slice that the datapath setup is complete. Completion of the datapath setup indicates that there is a L2 link from the slice virtual machine to the mobile client. |
| 30 | The addclient() API has an optional service class parameter that the user can specify. If the user does not specify the service class id, a default service class is allocated that has a single best effort type of service flow. After this sequence is complete, the user can direct traffic to the local virtual interface in the VM with the appropriate MAC address, and traffic will be automatically sent to the correct wireless client. |
| 31 | |
| 32 | == Sample Experiment: Custom Service Class Control == |
| 33 | To demonstrate how the user could possibly create custom service classes we show an |
| 34 | example of how system components will interact in the Figure below. |
| 35 | |
| 36 | The process starts when the user requests the radio manager grid service for creation of |
| 37 | a custom service class. As a part of this request we are assuming that the user intends to create the new service class using existing pre-defined service flows. The installation supports 5 pre-defined service flows which represent a typical setting with every traffic type. The user could also define a custom service flow and include it as a part of its customized service class. If the service class request by the user is valid, and all flows requested as a part of the service class request are valid, the system assigns the service class a service class id (SCID). The RM service will create an internal record of the service class parameters when it assigns the service class id (SCID). The slice user can actually start using the service class only after invoking the installServiceClass(MAC, SCID) API. This results in the addition of all service flows for the client by the modified BS controller, and appropriate datapath mapping by the datapath controller. In the illustration we see the addition of two service flows when the SCID is being installed for the MAC. |
| 38 | |