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

Developer

API Reference

IQOSBUNDLE_DEACTIVATE()

Brew Release
Brew MP 1.0.2
See Also
IQoSBundle_GetError() AEEQoSSessionError
Description
This function is used in order to suspend multiple QoS links.
The number of requested QoS Sessions in a bundle is limited and cannot exceed MAX_UINT8.
All QoS Sessions which are requested to be suspended must be linked to the same network, otherwise the operation will fail and none of the QoS Session instances will be suspended.
In addition all QoS Sessions which are requested to be suspended must be in a state which enables suspension, otherwise the operation will fail and none of the QoS Session instances will be suspended.
Note that a return value of AEE_SUCCESS indicates that the request was successfully issued but it doesn't indicate that the QoS Sessions are already suspended. After IQoSBundle_Deactivate() returns AEE_SUCCESS, the client should listen (see IQoSSession_AddListener()) for QoS events, separately for each QoS Session, which indicate that QoS was suspended (DSS_IFACE_IOCTL_QOS_AVAILABLE_DEACTIVATED_EV).
After calling IQoSBundle_Deactivate(), the QoS Bundle object can be re-used for any other multiple session operations with any bundle of IQoSSession objects.
Params
po
[]:
the interface pointer.
pIQoSSessions
[]:
list of valid QoS sessions to be suspended.
Interface
Prototype
  •    int IQoSBundle_Deactivate(IQoSBundle* po, IQoSList* pIQoSSessions);
    
Return
  • AEE_SUCCESS: the request was successfully issued. This doesn't indicate that the QoS Sessions are already suspended.
    AEE_EBADPARM: the QoS Session list is invalid.
    AEE_NET_EQOS_NET_CONFLICT: conflict between the QoS Session's networks.
    AEE_NET_EQOS_SESSION_INVALID_OPT: at least one of the QoS Session in the list is invalid or prevented the Deactivate operation from ending successfully e.g. the QoSSession state is not suitable for this operation, Use IQoSBundle_GetError() to identify the index to the first QoS Session in the list which caused the failure and to reveal the error code (See AEEQoSSessionError).
    AEE_NET_EQOSUNAWARE : the current network is CDMA QoS Unaware System (does not support QoS).
    EAEE_NOMEMORY: out of memory.
    Other error codes are also possible.
Side Effect
  • None.
Comments
None.