SFBBTConnection

Wrapper Class for the IBTConnection interface.

#include <SFBBTConnection.h.hpp>

class SFBBTConnection : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBTConnection)

Inheritance diagram

Version

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

Reference

BREW API IBTConnection

Member

Public Functions
`SFCError`	GetEvent( `BTConnEventType ` event , `BTResult ` result ) Retrieve the next event on the connection object.
`SFCError`	GetStatus( `BTConnStatBitmap ` bitmap , `BTConnectionStatus ` status ) Retrieve the current connection status.
static `SFBBTConnectionSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBBTConnection instance.
static `SFBBTConnectionSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBTConnection instance.
`SFCError`	OnEventNotify( `SFBSignalSmpConstRef` signal ) Register a signal to be triggered when there is an event that occurred on the IBTConnection object.
`SFCError`	SetLowPowerConfig( `BTLowPowerMode` mode , `UInt16` interval , `UInt16` timeout ) Set the low power mode for the connection.
`SFCError`	SetMinSecurity( `BTSecurityLevel` security ) Set the minimum security level for the connection.
`SFCError`	SetRole( `Bool` master ) Cause a role switch attempt to be made.
`SFCError`	SetRoleSwitchPolicy( `Bool` allow ) Set the role switch policy for the connection.
`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.

SFBBTConnection::GetEvent

Retrieve the next event on the connection object.

[ public ]
SFCError GetEvent(
    BTConnEventType * event   // destination for the event code
    BTResult * result         // only valid for event representing failure operation
);

Reference

BREW API IBTConnection_GetEvent

SFBBTConnection::GetStatus

Retrieve the current connection status.

[ public ]
SFCError GetStatus(
    BTConnStatBitmap * bitmap     // bitmap of fields that are valid
    BTConnectionStatus * status   // destination for current connection status
);

Reference

BREW API IBTConnection_GetStatus

SFBBTConnection::NewInstance

Create a new SFBBTConnection instance.

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

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

SFBBTConnection::OnEventNotify

[ public ]
SFCError OnEventNotify(
    SFBSignalSmpConstRef signal   // signal to be triggered when an event occurs
);

Reference

BREW API IBTConnection_OnEventNotify

SFBBTConnection::SetLowPowerConfig

Set the low power mode for the connection.

[ public ]
SFCError SetLowPowerConfig(
    BTLowPowerMode mode   // low power mode
    UInt16 interval       // maximum number of milliseconds between
    UInt16 timeout        // number of milliseconds of non-activity before lower power mode is entered
);

Reference

BREW API IBTConnection_SetLowPowerConfig

SFBBTConnection::SetMinSecurity

Set the minimum security level for the connection.

[ public ]
SFCError SetMinSecurity(
    BTSecurityLevel security   // minimum security level to apply
);

Reference

BREW API IBTConnection_SetMinSecurity

SFBBTConnection::SetRole

Cause a role switch attempt to be made.

[ public ]
SFCError SetRole(
    Bool master   // true to make local master of the connection
);

Reference

BREW API IBTConnection_SetRole

SFBBTConnection::SetRoleSwitchPolicy

Set the role switch policy for the connection.

[ public ]
SFCError SetRoleSwitchPolicy(
    Bool allow   // true if role switch should be allowed; false if disallowed
);

Reference

BREW API IBTConnection_SetRoleSwitchPolicy