SFBQoSSession

Wrapper class for the IQoSSession interface.

#include <SFBQoSSession.h.hpp>

class SFBQoSSession : public SFBModel;

SFMTYPEDEFWRAPPER(SFBQoSSession)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API IQoSSession

Member

Public Functions
`SFCError`	AddRetryCB( `SFXCallbackPtr` callback ) Prepare for receiving the notify to call the SFBQoSSession::Open function again.
`SFCError`	Close( `Void` ) Issues a request for closing a QoS Session.
`SFCError`	GetErrorSpec( `SFBQoSErrorSpecSmpPtr` error ) Get the SFBQoSErrorSpec for client to recognize the invalid option of requested QoS Spec.
`SFBQoSErrorSpecSmp`	GetErrorSpec( `Void` ) Get the SFBQoSErrorSpec for client to recognize the invalid option of requested QoS Spec.
`SFCError`	GetFlowSpec( `SFBQoSFlowSmpPtr` rxFlow , `SFBQoSFlowSmpPtr` txFlow ) Return the current Rx and Tx Flow Specs.
`SFCError`	GetGrantedFlowSpecDuringAnyState( `SFBQoSFlowSmpPtr` rxFlow , `SFBQoSFlowSmpPtr` txFlow ) Return the current Rx and Tx Flow Specs.
`AEEQoSStatus`	GetStatus( `Void` ) Returns the status of the QoS link.
`SFCError`	GoActive( `Void` ) This function is used in order to activate the QoS link (from dormant mode).
`SFCError`	Modify( `SFBQoSSpecSmpConstRef` qos ) Issues a request for modifying an existing QoS Session.
`SFCError`	ModifyEx( `SFBQoSSpecSmpConstRef` qos , `AEEQoSModifyExMask` mask ) Issue the modification requests.
static `SFBQoSSessionSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBQoSSession instance.
static `SFBQoSSessionSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBQoSSession instance.
`SFCError`	Open( `SFBQoSSpecSmpConstRef` qos ) Issues a request for establishing a new QoS Session.
`SFCError`	SelectNetwork( `SInt32` network ) Select a specific data network for this QoS Session.
`SFCError`	SetDormancyTimeout( `UInt08` seconds ) Set the IS-707 (cdma2000 1x) packet data dormancy timeout for the QoS link.
`SFCError`	AddListener( `ModelListener*` listener ) (inherits from SFBModel) Allow objects such as widgets and UI controls to attach a listener to the given model.
`SFCError`	AddListenerEx( `ModelListener*` listener , `PFNLISTENER` notify , `VoidPtr` data ) (inherits from SFBModel) Initialize the fields of a ModelListener, and register the listener with the model.
`SFCError`	Notify( `ModelListener*` listener ) (inherits from SFBModel) send a notify event to all listeners that are currently installed on the model. The notification will be sent to the function specified by the pfnListener member of the ModelListener data structure passed to SFBModel:AddListener().
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBQoSSession::AddRetryCB

Prepare for receiving the notify to call the SFBQoSSession::Open function again.

[ public ]
SFCError AddRetryCB(
    SFXCallbackPtr callback   // callback of client
);

Return value

If succeeds: SFERR_NO_ERROR
callback is null: SFERR_INVALID_PARAM

Reference

BREW API IQOSSESSION_AddRetryCB | SFBQoSSession::Open

SFBQoSSession::Close

Issues a request for closing a QoS Session.

[ public ]
SFCError Close(Void);

Return value

If succeeds: SFERR_NO_ERROR
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE

Reference

BREW API IQOSSESSION_Close | SFBQoSSession::Open | SFBModel::AddListener

SFBQoSSession::GetErrorSpec

Get the SFBQoSErrorSpec for client to recognize the invalid option of requested QoS Spec.

[ public ]
SFCError GetErrorSpec(
    SFBQoSErrorSpecSmpPtr error   // current Error Spec
);

[ public ]
SFBQoSErrorSpecSmp GetErrorSpec(Void);

Return value

If succeeds: SFERR_NO_ERROR
error is null: SFERR_INVALID_PARAM
Operation is not supported: SFERR_UNSUPPORTED
If failed: SFERR_FAILED

Reference

BREW API IQOSSESSION_GetErrorSpec

SFBQoSSession::GetFlowSpec

Return the current Rx and Tx Flow Specs.

[ public ]
SFCError GetFlowSpec(
    SFBQoSFlowSmpPtr rxFlow   // current Rx Flow Spec; can be null, if the caller is not interested in
    SFBQoSFlowSmpPtr txFlow   // current Tx Flow Spec; can be null, if the caller is not interested in
);

Return value

If succeeds: SFERR_NO_ERROR
Both rxFlow and txFlow is null: SFERR_NO_ERROR
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE

Reference

BREW API IQOSSESSION_GetFlowSpec | SFBQoSFlow | SFBQoSSession::Open

SFBQoSSession::GetGrantedFlowSpecDuringAnyState

Return the current Rx and Tx Flow Specs.

[ public ]
SFCError GetGrantedFlowSpecDuringAnyState(
    SFBQoSFlowSmpPtr rxFlow   // current Rx Flow Spec; can be null, if the caller is not interested in
    SFBQoSFlowSmpPtr txFlow   // current Tx Flow Spec; can be null, if the caller is not interested in
);

Version

Introduced BREW Client 3.1.5 SP01

Reference

BREW API IQoSSession_GetGrantedFlowSpecDuringAnyState | SFBQoSSpec

SFBQoSSession::GetStatus

Returns the status of the QoS link.

[ public ]
AEEQoSStatus GetStatus(Void);

Reference

BREW API IQOSSESSION_GetStatus

SFBQoSSession::GoActive

This function is used in order to activate the QoS link (from dormant mode).

[ public ]
SFCError GoActive(Void);

Return value

If succeeds: SFERR_NO_ERROR
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE

Reference

BREW API IQOSSESSION_GoActive

SFBQoSSession::Modify

Issues a request for modifying an existing QoS Session.

[ public ]
SFCError Modify(
    SFBQoSSpecSmpConstRef qos   // the new QoS specification to apply to the QoS session
);

Return value

If succeeds: SFERR_NO_ERROR
The desired QoS specification is not valid: SFERR_INVALID_PARAM
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE
Operation is not supported: SFERR_UNSUPPORTED
The desired QoS specification contains invalid options : AEE_NET_EQOS_SPEC_INVALID_OPT
If failed: Error code defined in AEEError.h

Reference

BREW API IQOSSESSION_Modify | SFBQoSSession::Open | SFBQoSSession::GetErrorSpec

SFBQoSSession::ModifyEx

Issue the modification requests.

[ public ]
SFCError ModifyEx(
    SFBQoSSpecSmpConstRef qos   // the QoS specification used for modifying
    AEEQoSModifyExMask mask     // bit mask which indicates the QoS specification blocks to be modified
);

Version

Introduced BREW Client 3.1.5 SP01

Reference

BREW API IQoSSession_ModifyEx | SFBQoSSpec

SFBQoSSession::NewInstance

Create a new SFBQoSSession instance.

[ public, static ]
SFBQoSSessionSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBQoSSessionSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBQoSSession::Open

Issues a request for establishing a new QoS Session.

[ public ]
SFCError Open(
    SFBQoSSpecSmpConstRef qos   // the desired QoS specification for the new session
);

Return value

If succeeds: SFERR_NO_ERROR
The desired QoS specification is not valid: SFERR_INVALID_PARAM
If insufficient memory: SFERR_NO_MEMORY
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE
The desired QoS specification contains invalid options : AEE_NET_EQOS_SPEC_INVALID_OPT
Operation cannot be completed right now; try again later : AEE_NET_WOULDBLOCK
Network is not available : AEE_NET_ENETNONET
If failed: Error code defined in AEEError.h

Reference

SFBQoSSession::SelectNetwork

Select a specific data network for this QoS Session.

[ public ]
SFCError SelectNetwork(
    SInt32 network   // the network for this QoS Session. one of AEE_NETWORK_* constants
);

Return value

If succeeds: SFERR_NO_ERROR
The network has already been selected: SFERR_INVALID_STATE
If failed: SFERR_FAILED
The network is invalid : AEE_NET_EINVAL

Reference

BREW API IQOSSESSION_SelectNetwork | SFBQoSSession::Open | SFBNetMgr::SelectNetwork

SFBQoSSession::SetDormancyTimeout

Set the IS-707 (cdma2000 1x) packet data dormancy timeout for the QoS link.

[ public ]
SFCError SetDormancyTimeout(
    UInt08 seconds   // dormant timeout in seconds.
);

Return value

If succeeds: SFERR_NO_ERROR
Operation is not supported: SFERR_UNSUPPORTED
QoSSession state is not suitable for this operation: SFERR_INVALID_STATE
If failed: SFERR_FAILED
Network not suitable for this operation : AEE_NET_EOPNOTSUPP

Reference

BREW API IQOSSESSION_SetDormancyTimeout