SFBOBEXSrv

Wrapper Class for the IOBEXSrv interface.

#include <SFBOBEXSrv.h.hpp>

class SFBOBEXSrv : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBOBEXSrv)

Inheritance diagram

Version

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

Reference

BREW API IOBEXSrv

Member

Public Functions
`SFCError`	Deregister( `Void` ) Deregister the OBEX server.
`SFCError`	GetEvent( `AEEOBEXEventType ` id , `AEEOBEXCmdStatus ` status , `SFBOBEXSrvSessionSmpPtr` session ) Retrieve the event, after the signal registered via OnEventNotify() is triggered.
`SFCError`	GetParams( `AEEOBEXParamType` paramType , `UInt32Ptr` u32 , `UInt08Ptr` param , `SInt32` paramLen , `SInt32Ptr` paramLenreq ) Read information from the interface.
`SFCError`	GetParams( `AEEOBEXParamType` paramType , `UInt32Ptr` u32 , `SFXBufferPtr` param ) Read information from the interface.
`SFCError`	GetParams( `AEEOBEXParamType` paramType , `UInt32Ptr` u32 , `SFXAnsiStringPtr` param ) Read information from the interface.
`SFCError`	GetSupportedTransports( `AEEOBEXTransport *` transport , `SInt32` length , `SInt32Ptr` lenreq ) Retrieve the supported transports.
static `SFBOBEXSrvSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBOBEXSrv instance.
static `SFBOBEXSrvSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBOBEXSrv instance.
`SFCError`	OnEventNotify( `SFBSignalSmpConstRef` signal ) Register a signal which is set when the application is to be notified of an event.
`SFCError`	Register( `AEEOBEXTransport` transType , `UInt08Ptr` target , `SInt32` targetLen , `ACharConstPtr` string ) Register an OBEX server over a particular transport.
`SFCError`	Register( `AEEOBEXTransport` transType , `SFXBufferPtr` target , `SFXAnsiStringConstRef` string ) Register an OBEX server over a particular transport.
`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.

SFBOBEXSrv::Deregister

Deregister the OBEX server.

[ public ]
SFCError Deregister(Void);

Reference

BREW API IOBEXSrv_Deregister

SFBOBEXSrv::GetEvent

Retrieve the event, after the signal registered via OnEventNotify() is triggered.

[ public ]
SFCError GetEvent(
    AEEOBEXEventType * id             // event type
    AEEOBEXCmdStatus * status         // command status
    SFBOBEXSrvSessionSmpPtr session   // this location will contain pointer to the server session object if event is AEEOBEX_EVT_SRV_NEW_CLI. null otherwise.
);

Reference

BREW API IOBEXSrv_GetEvent | SFBOBEXSrvSession

SFBOBEXSrv::GetParams

Read information from the interface.

[ public ]
SFCError GetParams(
    AEEOBEXParamType paramType   // parameter type
    UInt32Ptr u32                // place holdater for a 4 byte value
    UInt08Ptr param              // buffer to hold the parameter
    SInt32 paramLen              // length of the buffer
    SInt32Ptr paramLenreq        // if return value is AEE_EBUFFERTOOSMALL, this location contains length of the buffer required to hold the parameter
);

[ public ]
SFCError GetParams(
    AEEOBEXParamType paramType   // parameter type
    UInt32Ptr u32                // place holdater for a 4 byte value
    SFXBufferPtr param           // buffer to hold the parameter
);

[ public ]
SFCError GetParams(
    AEEOBEXParamType paramType   // parameter type
    UInt32Ptr u32                // place holdater for a 4 byte value
    SFXAnsiStringPtr param       // string to hold the parameter
);

Reference

BREW API IOBEXSrv_GetParams

SFBOBEXSrv::GetSupportedTransports

Retrieve the supported transports.

[ public ]
SFCError GetSupportedTransports(
    AEEOBEXTransport * transport   // array of supported transports
    SInt32 length                  // number of the elements in array
    SInt32Ptr lenreq               // number of the elements required in the array to return all transports
);

Reference

BREW API IOBEXSrv_GetSupportedTransports

SFBOBEXSrv::NewInstance

Create a new SFBOBEXSrv instance.

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

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

SFBOBEXSrv::OnEventNotify

[ public ]
SFCError OnEventNotify(
    SFBSignalSmpConstRef signal   // signal that is set when an event is to be delivered to the app
);

Reference

BREW API IOBEXSrv_OnEventNotify

SFBOBEXSrv::Register

[ public ]
SFCError Register(
    AEEOBEXTransport transType   // transport type
    UInt08Ptr target             // buffer containing target Id
    SInt32 targetLen             // target Id length
    ACharConstPtr string         // null terminated string containing transport
);

[ public ]
SFCError Register(
    AEEOBEXTransport transType     // transport type
    SFXBufferPtr target            // buffer containing target Id
    SFXAnsiStringConstRef string   // string containing transport
);

Reference

BREW API IOBEXSrv_Register