SFBBCMCSDB

Wrapper Class for the IBCMCSDB interface.

#include <SFBBCMCSDB.h.hpp>

class SFBBCMCSDB : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBCMCSDB)

Inheritance diagram

Version

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

Reference

BREW API IBCMCSDB

Member

Public Functions
static `SFBBCMCSDBSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBBCMCSDB instance.
static `SFBBCMCSDBSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBCMCSDB instance.
`SFCError`	Update( `SFBWebOptsSmpConstRef` bcmcsDbRecord , `UInt32` uUpdateMode ) Add a record to the BCMCS DB of flow mapping information.
`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.

SFBBCMCSDB::NewInstance

Create a new SFBBCMCSDB instance.

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

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

SFBBCMCSDB::Update

Add a record to the BCMCS DB of flow mapping information.

[ public ]
SFCError Update(
    SFBWebOptsSmpConstRef bcmcsDbRecord   // The BCMCS DB record to be added 
    UInt32 uUpdateMode                    // Mode of update.
);

Argument

bcmcsDbRecord: The BCMCS DB record to be added.
uUpdateMode: Mode of update. By default, a record will overwrite a matching record that already exists in the database. However, if flag AEEBCMCSDB_FLAG_NO_OVERWRITE is specified, trying to add a record that matches an existing record will result in an error. Matching is done by comparing IP Address, Port and HDR Zone fields.

Return value

AEE_SUCCESS: BCMCS DB was updated successfully.
AEE_EBADITEM: missing or invalid option in the BCMCS DB Record.
AEE_NET_EBCMCSDB_FULL: EBCMCSDB_FULL: BCMCS DB is full.
AEE_NET_EBCMCSDB_EXIST: a matching DB record exists, and flag AEEBCMCSDB_FLAG_NO_OVERWRITE was specified.

Other error codes are also possible.

Reference

BREW API IBCMCSDB_Update