SFBQoSSpec

Wrapper class for the IQoSSpec interface.

#include <SFBQoSSpec.h.hpp>

class SFBQoSSpec : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBQoSSpec)

Inheritance diagram

Version

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

Reference

BREW API IQoSSpec

Member

Public Functions
`SFCError`	GetRxFilterSpec( `SFBQoSListSmpPtr` filterList ) Get the list of Rx Filter specs that is stored in the SFBQoSSpec object.
`SFBQoSListSmp`	GetRxFilterSpec( `Void` ) Get the list of Rx Filter specs that is stored in the SFBQoSSpec object.
`SFCError`	GetRxFlowSpec( `SFBQoSListSmpPtr` flowList ) Get the list of Rx Flow specs that is stored in the SFBQoSSpec object.
`SFBQoSListSmp`	GetRxFlowSpec( `Void` ) Get the list of Rx Flow specs that is stored in the SFBQoSSpec object.
`SFCError`	GetTxFilterSpec( `SFBQoSListSmpPtr` filterList ) Get the list of Tx Filter specs that is stored in the SFBQoSSpec object.
`SFBQoSListSmp`	GetTxFilterSpec( `Void` ) Get the list of Tx Filter specs that is stored in the SFBQoSSpec object.
`SFCError`	GetTxFlowSpec( `SFBQoSListSmpPtr` flowList ) Get the list of Tx Flow specs that is stored in the SFBQoSSpec object.
`SFBQoSListSmp`	GetTxFlowSpec( `Void` ) Get the list of Tx Flow specs that is stored in the SFBQoSSpec object.
`SFCError`	LoadFlowSpecByProfile( `UInt32` ruleId , `UInt32` id ) Create the defined profile for the SFBQoSSpec which specified the Flow Spec of Rx and Tx.
static `SFBQoSSpecSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBQoSSpec instance.
static `SFBQoSSpecSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBQoSSpec instance.
`SFCError`	SetRxFilterSpec( `SFBQoSListSmpConstRef` filterList ) Set the list of Rx Filter specs that is stored in the SFBQoSSpec object.
`SFCError`	SetRxFlowSpec( `SFBQoSListSmpConstRef` flowList ) Set the list of Rx Flow specs that is stored in the SFBQoSSpec object.
`SFCError`	SetTxFilterSpec( `SFBQoSListSmpConstRef` filterList ) Set the list of Tx Filter specs that is stored in the SFBQoSSpec object.
`SFCError`	SetTxFlowSpec( `SFBQoSListSmpConstRef` flowList ) Set the list of Tx Flow specs that is stored in the SFBQoSSpec object.
`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.

SFBQoSSpec::GetRxFilterSpec

Get the list of Rx Filter specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError GetRxFilterSpec(
    SFBQoSListSmpPtr filterList   // returns the stored list of Rx Filter specs
);

[ public ]
SFBQoSListSmp GetRxFilterSpec(Void);

Return value

If succeeds: SFERR_NO_ERROR
filterList is null: SFERR_INVALID_PARAM

Reference

BREW API IQOSSPEC_GetRxFilterSpec | SFBQoSSpec::SetRxFilterSpec

SFBQoSSpec::GetRxFlowSpec

Get the list of Rx Flow specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError GetRxFlowSpec(
    SFBQoSListSmpPtr flowList   // returns the stored list of Rx Flow specs
);

[ public ]
SFBQoSListSmp GetRxFlowSpec(Void);

Return value

If succeeds: SFERR_NO_ERROR
flowList is null: SFERR_INVALID_PARAM

Reference

BREW API IQOSSPEC_GetRxFlowSpec | SFBQoSSpec::SetRxFlowSpec

SFBQoSSpec::GetTxFilterSpec

Get the list of Tx Filter specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError GetTxFilterSpec(
    SFBQoSListSmpPtr filterList   // returns the stored list of Tx Filter specs
);

[ public ]
SFBQoSListSmp GetTxFilterSpec(Void);

Return value

If succeeds: SFERR_NO_ERROR
filterList is null: SFERR_INVALID_PARAM

Reference

BREW API IQOSSPEC_GetTxFilterSpec | SFBQoSSpec::SetTxFilterSpec

SFBQoSSpec::GetTxFlowSpec

Get the list of Tx Flow specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError GetTxFlowSpec(
    SFBQoSListSmpPtr flowList   // returns the stored list of Tx Flow specs
);

[ public ]
SFBQoSListSmp GetTxFlowSpec(Void);

Return value

If succeeds: SFERR_NO_ERROR
flowList is null: SFERR_INVALID_PARAM

Reference

BREW API IQOSSPEC_GetTxFlowSpec | SFBQoSSpec::SetTxFlowSpec

SFBQoSSpec::LoadFlowSpecByProfile

Create the defined profile for the SFBQoSSpec which specified the Flow Spec of Rx and Tx.

[ public ]
SFCError LoadFlowSpecByProfile(
    UInt32 ruleId   // identifies the profile to use
    UInt32 id       // identifies the profile to use
);

Return value

If succeeds: SFERR_NO_ERROR
The specified prfile is invalid: SFERR_INVALID_PARAM
Operation is not supported: SFERR_UNSUPPORTED

Reference

BREW API IQOSSPEC_LoadFlowSpecByProfile

SFBQoSSpec::NewInstance

Create a new SFBQoSSpec instance.

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

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

SFBQoSSpec::SetRxFilterSpec

Set the list of Rx Filter specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError SetRxFilterSpec(
    SFBQoSListSmpConstRef filterList   // list of SFBQoSFilter objects to be used as the list of Rx Filter specs
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IQOSSPEC_SetRxFilterSpec | SFBQoSSession::Open | SFBQoSSession::Modify

SFBQoSSpec::SetRxFlowSpec

Set the list of Rx Flow specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError SetRxFlowSpec(
    SFBQoSListSmpConstRef flowList   // list of SFBQoSFilter objects to be used as the list of Rx Flow specs
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IQOSSPEC_SetRxFlowSpec | SFBQoSSession::Open | SFBQoSSession::Modify

SFBQoSSpec::SetTxFilterSpec

Set the list of Tx Filter specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError SetTxFilterSpec(
    SFBQoSListSmpConstRef filterList   // list of SFBQoSFilter objects to be used as the list of Tx Filter specs
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IQOSSPEC_SetTxFilterSpec | SFBQoSSession::Open | SFBQoSSession::Modify

SFBQoSSpec::SetTxFlowSpec

Set the list of Tx Flow specs that is stored in the SFBQoSSpec object.

[ public ]
SFCError SetTxFlowSpec(
    SFBQoSListSmpConstRef flowList   // list of SFBQoSFilter objects to be used as the list of Tx Flow specs
);

Return value

Return SFERR_NO_ERROR.

Reference

BREW API IQOSSPEC_SetTxFlowSpec | SFBQoSSession::Open | SFBQoSSession::Modify