API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

AEEQOSEVENT

Brew Release
Brew MP 1.0.2
See Also
IQoSSession_AddListener() IQoSSession_Open() IQoSSession_ModifyEx() IQoSSession_GoActive() IQoSSession_Deactivate() IQoSSession_SetDormancyTimeout() IQoSSpec AEEQoSInfoCode
Description
This data type is used for QoS events.
Members
  • AEE_QOS_AVAILABLE_EV:
    This event is no longer received. AEE_QOS_AVAILABLE_MODIFIED_EV will be received instead.
    This is a change from the previously documented semantics where the event was received in response to IQoSSession_Open() and IQoSSession_ModifyEx() operations that returned AEE_SUCCESS, to indicate that the most desirable IQoSFlow is now available.
  • AEE_QOS_AVAILABLE_MODIFIED_EV:
    This event is received under the following
  • AEE_QOS_UNAVAILABLE_EV:
    This event indicates that a requested QoS could not be assigned or an assigned QoS is not available anymore. The event is generated in the following
  • AEE_QOS_AVAILABLE_DEACTIVATED_EV:
    This event indicates that an assigned QoS is deactivated and all the resources are released. The event is generated in the following
  • AEE_QOS_MODIFY_ACCEPTED_EV:
    This event is generated in response to a IQoSSession_ModifyEx() operation that returned AEE_SUCCESS, and indicates that the network can grant the QoS Spec specified in that operation.
    This event does not change the QoS Sessions's status. If QoS Session's status is changed because of a IQoSSession_ModifyEx() operation, another event is posted to indicate its new status.
    Since the network may or may not grant a most desirable QoS, it is recommended that the applications should query the currently applied QoS using IQoSSession_GetFlowSpec() or IQoSSession_GetGrantedFlowSpecDuringAnyState(), and take an appropriate action if the granted QoS is not sufficient for the proper functioning of the application. The application may choose to release the QoS instance and report an error to the user and retry the original QoS request using IQoSSession_ModifyEx() after waiting for a period of time, although it may still not get the requested QoS if the network does not have sufficient resources to fulfill it.
  • AEE_QOS_MODIFY_REJECTED_EV:
    This event is generated in response to a IQoSSession_ModifyEx() operation that returned AEE_SUCCESS, and indicates that the network can not grant QoS Spec specified in that operation.
    This event does not change the QoS Sessions's status. If QoS Session's status is changed because of a IQoSSession_ModifyEx() operation, another event is posted to indicate its new status.
    The QoS Session requested by the application prior to the IQoSSession_ModifyEx() operation will remain unchanged.
  • AEE_QOS_INFO_CODE_UPDATED_EV:
    This event is generated when new information related to a QoS instance is available. The AEEQoSInfoCode passed with this event contains the updated information.
Definition
  •    #define AEE_QOS_AVAILABLE_EV              0
       #define AEE_QOS_AVAILABLE_MODIFIED_EV     1
       #define AEE_QOS_UNAVAILABLE_EV            2
       #define AEE_QOS_AVAILABLE_DEACTIVATED_EV  3
       #define AEE_QOS_MODIFY_ACCEPTED_EV        4
       #define AEE_QOS_MODIFY_REJECTED_EV        5
       #define AEE_QOS_INFO_CODE_UPDATED_EV      6
    
       typedef int AEEQoSEvent;
    
Comments
The generation of AEE_QOS_AVAILABLE_MODIFIED_EV event instead of AEE_QOS_AVAILABLE_EV event should not cause backward compatibility issues. Since network can modify the granted QoS at any time, "Older" applications should have handle both AEE_QOS_AVAILABLE_EV event and AEE_QOS_AVAILABLE_MODIFIED_EV event, and will not be affected by the new behavior. An application which handled the AEE_QOS_AVAILABLE_EV event but did not handle the AEE_QOS_AVAILABLE_MODIFIED_EV will need to be fixed.