SFBSource

Wrapper Class for the ISource interface.

#include <SFBSource.h.hpp>

class SFBSource : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBSource)

Inheritance diagram

Version

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

Reference

BREW API ISource

Member

Public Functions
static `Bool`	Exhausted( `SInt32` code ) Determine if a SFBSource, a SFBPeek, or a SFBGetLine is out of data.
`SInt32`	Read( `VoidPtr` buf , `SInt32` size ) Copy bytes from the source stream to the specified buffer.
`SInt32`	Read( `SFXBufferPtr` buf ) Copy bytes from the source stream to the specified buffer.
`Void`	Readable( `SFXCallbackPtr` callback ) Schedule a callback to be called when SFBSource::Read() is able to return something other than ISOURCE_WAIT.
`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.

SFBSource::Exhausted

Determine if a SFBSource, a SFBPeek, or a SFBGetLine is out of data.

[ public, static ]
Bool Exhausted(
    SInt32 code   // return value from Read(), Peek(), or GetLine()
);

Reference

BREW API ISOURCE_Exhausted

SFBSource::Read

Copy bytes from the source stream to the specified buffer.

[ public ]
SInt32 Read(
    VoidPtr buf   // pointer to the buffer to receive bytes read
    SInt32 size   // buffer size
);

[ public ]
SInt32 Read(
    SFXBufferPtr buf   // pointer to the buffer to receive bytes read. 
                       // if null, do nothing but return ISOURCE_ERROR (-1) 
);

Reference

BREW API ISOURCE_Read

SFBSource::Readable

Schedule a callback to be called when SFBSource::Read() is able to return something other than ISOURCE_WAIT.

[ public ]
Void Readable(
    SFXCallbackPtr callback   // where to call when the ISource may be readable
);

Reference

BREW API ISOURCE_Readable