wiki:Internal/WiMAX/WiMAXAPI/dSMDpAPI

Version 3 (modified by seskar, 14 years ago) ( diff )

Name changed from Internal/WiMAX/WiMAXAPI/SMDpAPI to Internal/WiMAX/WiMAXAPI/dSMDpAPI

Table of Contents

  1. API Classification and Usage
    1. Sample Experiment Setup Using API
    2. Sample Experiment: Custom Service Class Control
  2. Accessing the WiMAX Base Station
        1. Input Command
        2. Expected Output
        3. Input Command
        4. Expected Output
        5. Input Command
        6. Expected Output
        7. Input Command
        8. Expected Output
        9. Sample Experiment Script
  3. Slice Manager API Specification (User Exposed)
    1. SLICE (VM) Control Functions
      1. createSLICE
      2. destroySLICE
      3. startSLICE
      4. stopSLICE
      5. setSLICEParams
    2. Client Control Functions
      1. addClient
      2. deleteClient
  4. Radio Management API (User Exposed)
    1. Custom Service Class Suport
      1. createServiceFlow(SlideID, direction, priority, classifier-ips, …
      2. createServiceClass(SlideID,STIDs{})
      3. installServiceClass(SlideID,SCID)
      4. uninstallServiceClass(SlideID,SCID)
      5. deleteServiceClass(SlideID, SCID)
      6. deleteServiceFlow(SlideID, STID)
    2. Slice Radio Control
      1. setMinimalMcs(SliceID, MSID, SCID, mcs)
      2. setFixedMcs(SliceID, MSID, SCID, mcs)
      3. setRadioResource(SliceID, MSID, RR)
      4. setBandwithUlDlRatio(bandwidth UL_DL_ratio)
    3. Slice Radio Monitoring
      1. getAllClientsInfo( SLICEID )
      2. getClientInfo(SLICE ID, MSID)
      3. getSliceResource(SLICEID)
  5. System Administrator API Specification (Internal)
    1. VM Administration
      1. setSliceParams(SLICEID, disk_quota, cpu)
      2. getSliceParams(SLICEID)
    2. getTotalParams(SLICEID) =
  6. SM – Datapath API (Internal)
      1. addClient(VLAN, MSID)
      2. removeClient(VLAN, MSID)
  7. RM – Datapath API (Internal)
      1. addServiceFlow(MSID, Service class tlv)
      2. removeServiceFlow(MSID, Service class tlv)
  8. BSFB – Datapath API (Internal)
    1. Network Entry Control API Specification
      1. appendMACAcl
      2. removeMACAcl
      3. acceptMAC
      4. rejectMAC
      5. clientRegistration
      6. clientDeregistration
    2. Radio Level Monitoring
      1. getAvailableResources
      2. getMCS
      3. getThroughput
      4. getPacketLoss

SM – Datapath API (Internal)

These set of API are responsible for dealing with the datapath creation after slice initialization and client registration.

addClient(VLAN, MSID)

  • This function is invoked by the slice manager after the user requests it to add a client to the slice.
  • The slice manager looks up the appropriate VLAN tag number and requests that the MAC MSID of the mobile client be added to the VLAN.
  • This API facilitates half of the datapath creation, which will be completed when the MSID associates with the system.

removeClient(VLAN, MSID)

  • Compliments the addClient() function.
  • On the execution of this call the datapath manager removes the mapping from the slice virtual machine to the wireless mobile client.
Note: See TracWiki for help on using the wiki.