SFBBTSPPClient

Wrapper Class for the IBTSPPClient interface.

#include <SFBBTSPPClient.h.hpp>

class SFBBTSPPClient : public SFBBTSPP;

SFMTYPEDEFWRAPPER(SFBBTSPPClient)

Inheritance diagram

Version

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

Reference

BREW API IBTSPPClient

Member

Public Functions
`SFCError`	CancelServerSearch( `SFXCallbackPtr` callback ) Cancel a previously initiated server search.
`SFCError`	Connect( `BDAddress const ` address , `UInt32` channel , `BTResult ` result , `SFXCallbackPtr` callback ) Enables application implementing the SPP client role to connect to the SPP server whose BD address is given.
`SFCError`	FindServersInit( `UInt32` duration , `UInt32` maxServer ) Enable applications implementing the SPP client role to search for all SPP servers in the vicinity.
`SFCError`	FindServersNext( `UInt32Ptr` size , `SFXCallbackPtr` callback ) This function should be called to register a callback to be invoked when a server is found.
`SFCError`	GetServerInfo( `BTSPPDeviceInfo *` device ) This function should be called to retrieve the information on the next server found.
static `SFBBTSPPClientSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBBTSPPClient instance.
static `SFBBTSPPClientSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBTSPPClient instance.
`SFCError`	Close( `Void` ) (inherits from SFBPort) Close an opened port or stops a open in progress.
`SFCError`	Configure( `BTSPPConfig const ` config , `BTResult ` result , `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) Configure the stream.
`SFCError`	Disconnect( `BTResult *` result , `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) Terminate the SPP connection.
static `Bool`	Exhausted( `SInt32` code ) (inherits from SFBSource) Determine if a SFBSource, a SFBPeek, or a SFBGetLine is out of data.
`SFCError`	GetLastError( `Void` ) (inherits from SFBPort) Return the last error that occurred with the SFBPort.
`SFCError`	GetLineError( `BTSPPLineError *` error ) (inherits from SFBBTSPP) Retrieve the stream's current line error.
`SFCError`	GetModemStatus( `BTSPPModemStatus *` status ) (inherits from SFBBTSPP) Retrieve the stream's current modem status.
`SFCError`	GetStatus( `BTSPPStatus *` status ) (inherits from SFBBTSPP) Retrieve the stream's current status.
`SFCError`	IOCtl( `SInt32` option , `UInt32` val ) (inherits from SFBPort) Allow some control over the behaviour of an SFBPort.
`SFCError`	IOCtlEx( `BTSPPIOCtlCommand` command , `BTSPPModemStatus const *` status , `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) This function can be used to control or configure the stream.
`SFCError`	OnLineError( `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) Register a callback to be invoked when a line error occurs on the SPP stream associated with the SPP object.
`SFCError`	OnModemStatusChange( `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) Register a callback to be invoked when there's a change in the modem status associated with the SPP object.
`SFCError`	OnStatusChange( `SFXCallbackPtr` callback ) (inherits from SFBBTSPP) Register a callback to be invoked when there's a change in the SPP stream state associated with the SPP object.
`SFCError`	Open( `ACharConstPtr` port ) (inherits from SFBPort) Open the specified prt.
`SFCError`	Open( `SFXAnsiStringConstRef` port ) (inherits from SFBPort) Open the specified prt.
`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.
`SInt32`	Read( `VoidPtr` buf , `SInt32` size ) (inherits from SFBSource) Copy bytes from the source stream to the specified buffer.
`SInt32`	Read( `SFXBufferPtr` buf ) (inherits from SFBSource) Copy bytes from the source stream to the specified buffer.
`Void`	Readable( `SFXCallbackPtr` callback ) (inherits from SFBSource) Schedule a callback to be called when SFBSource::Read() is able to return something other than ISOURCE_WAIT.
`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.
`SInt32`	Write( `ACharConstPtr` port , `SInt32` bufSize ) (inherits from SFBPort) Copy bytes from the specified buffer to the source stream.
`SInt32`	Write( `SFXAnsiStringConstRef` buf ) (inherits from SFBPort) Copy bytes from the specified buffer to the source stream.
`SInt32`	Write( `SFXBufferConstRef` buf ) (inherits from SFBPort) Copy bytes from the specified buffer to the source stream.
`Void`	Writeable( `SFXCallbackPtr` callback ) (inherits from SFBPort) Schedule a function to be called when SFBPort::Write() would return something other than AEEPORT_WAIT.

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.

SFBBTSPPClient::CancelServerSearch

Cancel a previously initiated server search.

[ public ]
SFCError CancelServerSearch(
    SFXCallbackPtr callback   // called to indicate the search has been cancelled
);

Reference

BREW API IBTSPPClient_CancelServerSearch

SFBBTSPPClient::Connect

Enables application implementing the SPP client role to connect to the SPP server whose BD address is given.

[ public ]
SFCError Connect(
    BDAddress const * address   // BD address of the server of interest
    UInt32 channel              // server channel number to use
    BTResult * result           // result of the connect attempt
    SFXCallbackPtr callback     // called to deliver connect result
);

Reference

BREW API IBTSPPClient_Connect

SFBBTSPPClient::FindServersInit

Enable applications implementing the SPP client role to search for all SPP servers in the vicinity.

[ public ]
SFCError FindServersInit(
    UInt32 duration    // number of seconds to search
    UInt32 maxServer   // max number of servers to search for
);

Reference

BREW API IBTSPPClient_FindServersInit

SFBBTSPPClient::FindServersNext

This function should be called to register a callback to be invoked when a server is found.

[ public ]
SFCError FindServersNext(
    UInt32Ptr size            // size of the memory needed for the server information
    SFXCallbackPtr callback   // called to deliver memory size required for the next server
);

Reference

BREW API IBTSPPClient_FindServersNext

SFBBTSPPClient::GetServerInfo

This function should be called to retrieve the information on the next server found.

[ public ]
SFCError GetServerInfo(
    BTSPPDeviceInfo * device   // destination for server info
);

Reference

BREW API IBTSPPClient_GetServerInfo

SFBBTSPPClient::NewInstance

Create a new SFBBTSPPClient instance.

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

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