SFBBTSPP

Wrapper Class for the IBTSPP interface. This class is not directly used.

#include <SFBBTSPP.h.hpp>

class SFBBTSPP : public SFBPort;

SFMTYPEDEFWRAPPER(SFBBTSPP)

Inheritance diagram

Version

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

Reference

BREW API IBTSPP

Member

Public Functions
`SFCError`	Configure( `BTSPPConfig const ` config , `BTResult ` result , `SFXCallbackPtr` callback ) Configure the stream.
`SFCError`	Disconnect( `BTResult *` result , `SFXCallbackPtr` callback ) Terminate the SPP connection.
`SFCError`	GetLineError( `BTSPPLineError *` error ) Retrieve the stream's current line error.
`SFCError`	GetModemStatus( `BTSPPModemStatus *` status ) Retrieve the stream's current modem status.
`SFCError`	GetStatus( `BTSPPStatus *` status ) Retrieve the stream's current status.
`SFCError`	IOCtlEx( `BTSPPIOCtlCommand` command , `BTSPPModemStatus const *` status , `SFXCallbackPtr` callback ) This function can be used to control or configure the stream.
`SFCError`	OnLineError( `SFXCallbackPtr` callback ) Register a callback to be invoked when a line error occurs on the SPP stream associated with the SPP object.
`SFCError`	OnModemStatusChange( `SFXCallbackPtr` callback ) Register a callback to be invoked when there's a change in the modem status associated with the SPP object.
`SFCError`	OnStatusChange( `SFXCallbackPtr` callback ) Register a callback to be invoked when there's a change in the SPP stream state associated with the SPP object.
`SFCError`	Close( `Void` ) (inherits from SFBPort) Close an opened port or stops a open in progress.
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`	IOCtl( `SInt32` option , `UInt32` val ) (inherits from SFBPort) Allow some control over the behaviour of an SFBPort.
static `SFBPortSmp`	NewInstance( `SFCErrorPtr` exception = null ) (inherits from SFBPort) Create a new instance of SFBPort.
static `SFBPortSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBPort) Create a new instance of SFBPort.
`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.

SFBBTSPP::Configure

Configure the stream.

[ public ]
SFCError Configure(
    BTSPPConfig const * config   // configuration info according to RS232 specs
    BTResult * result            // Result of the configuration change
    SFXCallbackPtr callback      // called to deliver the configuration change result
);

Reference

BREW API IBTSPP_Configure

SFBBTSPP::Disconnect

Terminate the SPP connection.

[ public ]
SFCError Disconnect(
    BTResult * result         // result of Disconnect operation
    SFXCallbackPtr callback   // called to deliver Disconnect result
);

Reference

BREW API IBTSPP_Disconnect

SFBBTSPP::GetLineError

Retrieve the stream's current line error.

[ public ]
SFCError GetLineError(
    BTSPPLineError * error   // line error that occured on the stream
);

Reference

BREW API IBTSPP_GetLineError

SFBBTSPP::GetModemStatus

Retrieve the stream's current modem status.

[ public ]
SFCError GetModemStatus(
    BTSPPModemStatus * status   // modem status of the stream
);

Reference

BREW API IBTSPP_GetModemStatus

SFBBTSPP::GetStatus

Retrieve the stream's current status.

[ public ]
SFCError GetStatus(
    BTSPPStatus * status   // status of the stream
);

Reference

BREW API IBTSPP_GetStatus

SFBBTSPP::IOCtlEx

This function can be used to control or configure the stream.

[ public ]
SFCError IOCtlEx(
    BTSPPIOCtlCommand command         // the IO Control command to perform
    BTSPPModemStatus const * status   // modem status holder
    SFXCallbackPtr callback           // called to deliver the result
);

Reference

BREW API IBTSPP_IOCtlEx

SFBBTSPP::OnLineError

[ public ]
SFCError OnLineError(
    SFXCallbackPtr callback   // called to inform application there are line errors
);

Reference

BREW API IBTSPP_OnLineError

SFBBTSPP::OnModemStatusChange

[ public ]
SFCError OnModemStatusChange(
    SFXCallbackPtr callback   // called to inform application,modem status has changed
);

Reference

BREW API IBTSPP_OnModemStatusChange

SFBBTSPP::OnStatusChange

[ public ]
SFCError OnStatusChange(
    SFXCallbackPtr callback   // called to inform the application, SPP state has changed
);

Reference

BREW API IBTSPP_OnStatusChange