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

Developer

API Reference

IPRIMARYQOSSESSION_GETGRANTEDFLOWSPEC()

Brew Release
Brew MP 1.0.2
See Also
None.
Description
This function returns the granted Rx and Tx QoS Flow specifications for the Primary QoS.
This function should be called only when the Primary QoS Session's associated network is up.
If a network was not yet selected for the IPrimaryQoSSession instance, AEE_NETWORK_DEFAULT & AEE_AF_INET will be implicitly selected.
The client is responsible for releasing the returned Rx and Tx Flow Spec objects when they are not needed anymore.
Params
po
[]:
the interface pointer
ppRxFlowSpec
[out]:
returns the granted Rx Flow Spec of the Primary QoS. Can be NULL to indicate that the caller is not interested in the Rx Flow Spec.
ppTxFlowSpec
[out]:
returns the granted Tx Flow Spec of the Primary QoS. Can be NULL to indicate that the caller is not interested in the Tx Flow Spec.
Interface
Prototype
  •    int IPrimaryQoSSession_GetGrantedFlowSpec(IPrimaryQoSSession *po,
                                                 IQoSFlow** ppRxFlowSpec,
                                                 IQoSFlow** ppTxFlowSpec);
    
Return
  • AEE_NET_SUCCESS: current Primary QoS's Rx and Tx Flow Specs were successfully retrieved.
    AEE_EBADSTATE: PrimaryQoSSession state is not suitable for this operation (associated network is not up).
    AEE_EUNSUPPORTED: operation not supported.
    Other error codes are also possible.
Side Effect
  • None.
Comments
If both ppRxFlowSpec and ppTxFlowSpec are NULL, the function returns immediately with AEE_NET_SUCCESS.