[[TOC(Internal/WiMAX/WiMAXAPI,Internal/WiMAX/WiMAXAPI/SliceMgmt,Internal/WiMAX/WiMAXAPI/RadioMgmt,Internal/WiMAX/WiMAXAPI/SMDpAPI)]]

= API Classification and Usage =


The APIs dare primarily classified as:
  * User exposed
    * [wiki:Internal/WiMAX/WiMAXAPI/SliceMgmt Slice management service]
    * [wiki:Internal/WiMAX/WiMAXAPI/RadioMgmt Radio management service]

  * Internal
   * [wiki:Internal/WiMAX/WiMAXAPI/SMDpAPI SM-Datapath API]
   * [wiki:Internal/WiMAX/WiMAXAPI/RMDpApi RM-Datapath API]
   * [wiki:Internal/WiMAX/WiMAXAPI/BSFBDpApi BSFB-Datapath API]

User exposed APIs are those that will be available to slice users for allowing experiment configuration and permitting smooth automated experimentation. This API will allow the users of a virtualized system to have a standard interface for common activities while being independent of the technology used underneath.  An example could be, that irrespective of the virtualization technology used to create virtual machines (KVM, OpenVZ or Xen), all standard API calls will allow the user to work oblivious to the underlying details. Slice management APIs allow the user to configure slice parameters such as settings of the VM. Radio resource management (RRM) parameters allow the user to monitor radio level information such as per client MCS.  

The other set of APIs are classified as internal API. These API are useful for understanding the interaction between different components of the system and provide means for appending or changing functionality of the system.  The SM-Datapath API describes the API used for communication between the slice manager grid service and the datapath controller. The RM-Datapath controller describes the API used for interaction between Radio resource grid service and the datapath generator.  The BSFB-Datapath API is the API used for interaction between the BS Feedback mechanism, which is a part of the customized NEC R6 controller and the datapath manager.