SophiaFramework UNIVERSE 5.3 |
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
X | X | O | O |
Public Functions | |
---|---|
SFCError |
Authenticate(
AEEOBEXCharSet charSet
, UInt08Ptr realm
, SInt32 length
, Bool uid
, Bool acs
) A client can call this method to indicate to the OBEX implementation that it should authenticate the server.
|
SFCError |
Authenticate(
AEEOBEXCharSet charSet
, SFXAnsiStringPtr realm
, Bool uid
, Bool acs
) A client can call this method to indicate to the OBEX implementation that it should authenticate the server.
|
SFCError |
CreateHeaderList(
SFBOBEXHeaderSmpPtr header
) A client can call this method to get a pointer to OBEX header list object.
|
SFCError |
GetAuthChallenge(
BoolPtr userIdReq
, BoolPtr fullAccess
, AEEOBEXCharSet * charSet
, UInt08Ptr realm
, SInt32 length
, SInt32Ptr lenreq
) This function should be called to retrieve the authentication challenge parameters when the client receives the AEEOBEX_EVT_AUTH_CHALLENGE event.
|
SFCError |
GetAuthChallenge(
BoolPtr userIdReq
, BoolPtr fullAccess
, AEEOBEXCharSet * charSet
, SFXAnsiStringPtr realm
) This function should be called to retrieve the authentication challenge parameters when the client receives the AEEOBEX_EVT_AUTH_CHALLENGE event.
|
SFCError |
GetAuthResponse(
AEEOBEXAuthResp * authResponse
) This function should be called to retrieve the authentication response parameters when the client receives the AEEOBEX_EVT_AUTH_RESPONSE event.
|
SFCError |
GetEvent(
AEEOBEXEventType * eventId
, SFBOBEXHeaderSmpPtr header
, AEEOBEXCmdStatus * status
, AEEOBEXFlags * flag
) Retrieve events.
|
SFCError |
GetParams(
AEEOBEXParamType paramType
, UInt32Ptr u32
, UInt08Ptr param
, SInt32 paramLen
, SInt32Ptr paramLenreq
) Read information.
|
SFCError |
GetParams(
AEEOBEXParamType paramType
, UInt32Ptr u32
, SFXBufferPtr param
) Read information.
|
SFCError |
GetParams(
AEEOBEXParamType paramType
, UInt32Ptr u32
, SFXAnsiStringPtr param
) Read information.
|
SFCError |
GetSupportedTransports(
AEEOBEXTransport * transport
, SInt32 length
, SInt32Ptr lenreq
) Retrieve the supported transports.
|
static SFBOBEXCliSmp |
NewInstance(
SFCErrorPtr exception = null
) Create a new SFBOBEXCli instance.
|
static SFBOBEXCliSmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
) Create a new SFBOBEXCli instance.
|
SFCError |
OnEventNotify(
SFBSignalSmpConstRef signal
) Register a signal that will be triggered when an event is ready to be delivered to the application.
|
SFCError |
Put(
SFBOBEXHeaderSmpConstRef header
, Bool final
) |
SFCError |
SendCmd(
AEEOBEXRequestType obexReq
, SFBOBEXHeaderSmpConstRef header
, AEEOBEXFlags flag
, Bool final
) Send an OBEX command to the server
|
SFCError |
SetPath(
SFBOBEXHeaderSmpConstRef header
, Bool upLevel
, Bool dontCreate
) Set the path on the server for subsequent PUT/GET operations.
|
SFCError |
SetTransport(
AEEOBEXTransport transType
, ACharConstPtr string
) Set the transport to be used.
|
SFCError |
SetTransport(
AEEOBEXTransport transType
, SFXAnsiStringConstRef string
) Set the transport to be used.
|
SFCError |
SetUidPassword(
UInt08ConstPtr uid
, SInt32 uidLen
, UInt08ConstPtr password
, SInt32 passwordLen
) Provide information that is required for authentication.
|
SFCError |
SetUidPassword(
SFXAnsiStringConstRef uid
, SFXAnsiStringConstRef password
) Provide information that is required for authentication.
|
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.
|
[ public ] SFCError Authenticate( AEEOBEXCharSet charSet // character set in which the realm string is encoded UInt08Ptr realm // pointer to realm information SInt32 length // realm length Bool uid // indicate if user id is required; true if the client requires UserID from the server, false if the client does not require User Id from the server Bool acs // type of Access; true for full access, false for read only access );
[ public ] SFCError Authenticate( AEEOBEXCharSet charSet // character set in which the realm string is encoded SFXAnsiStringPtr realm // realm information Bool uid // indicate if user id is required; true if the client requires UserID from the server, false if the client does not require User Id from the server Bool acs // type of Access; true for full access, false for read only access );
[ public ] SFCError CreateHeaderList( SFBOBEXHeaderSmpPtr header // place holder for smart pointer to SFBOBEXHeader class );
[ public ] SFCError GetAuthChallenge( BoolPtr userIdReq //indicates if the server requested for Uid BoolPtr fullAccess // place holder for access granted by the server AEEOBEXCharSet * charSet // character set used for encoding the realm UInt08Ptr realm // realm string SInt32 length // buffer allocated for the realm string SInt32Ptr lenreq // if the buffer allocated for the realm string is insufficient, this location contains the required buffer length );
[ public ] SFCError GetAuthChallenge( BoolPtr userIdReq // indicates if the server requested for Uid BoolPtr fullAccess // place holder for access granted by the server AEEOBEXCharSet * charSet // character set used for encoding the realm SFXAnsiStringPtr realm // realm string to get );
[ public ] SFCError GetAuthResponse( AEEOBEXAuthResp * authResponse // pointer to the buffer to read authentication response );
[ public ] SFCError GetEvent( AEEOBEXEventType * eventId // place holder for event id for the event being retrieved SFBOBEXHeaderSmpPtr header // if the event is accompanied by headers this location will contain smart pointer to SFBOBEXHeader Object. AEEOBEXCmdStatus * status // place holder for command status AEEOBEXFlags * flag // flags; currently not used );
[ public ] SFCError GetParams( AEEOBEXParamType paramType // parameter type UInt32Ptr u32 // place holder for a four byte parameter 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 holder for a four byte parameter SFXBufferPtr param // buffer to hold the parameter );
[ public ] SFCError GetParams( AEEOBEXParamType paramType // parameter type UInt32Ptr u32 // place holder for a four byte parameter SFXAnsiStringPtr param // string to hold the parameter );
[ 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 );
[ public, static ] SFBOBEXCliSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBOBEXCliSmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
[ public ] SFCError OnEventNotify( SFBSignalSmpConstRef signal // signal to be registered );
[ public ] SFCError Put( SFBOBEXHeaderSmpConstRef header // the list of OBEX headers to be sent Bool final // indicates this is the last block of data to send to the server );
[ public ] SFCError SendCmd( AEEOBEXRequestType obexReq // OBEX request type SFBOBEXHeaderSmpConstRef header // optional OBEX header sent with the command AEEOBEXFlags flag // optional flags for this command Bool final // indicates if this is the last packet int the request phase );
[ public ] SFCError SetPath( SFBOBEXHeaderSmpConstRef header // the list of OBEX headers to be sent Bool upLevel // change directory up one level Bool dontCreate // dont create directory if it dosent already exist );
[ public ] SFCError SetTransport( AEEOBEXTransport transType // transport type ACharConstPtr string // null terminated string indicating transport parameters );
[ public ] SFCError SetTransport( AEEOBEXTransport transType // transport type SFXAnsiStringConstRef string // string indicating transport parameters );
[ public ] SFCError SetUidPassword( UInt08ConstPtr uid // pointer to userID SInt32 uidLen // user id length UInt08ConstPtr password // password for userID SInt32 passwordLen // password length );
[ public ] SFCError SetUidPassword( SFXAnsiStringConstRef uid // userID string SFXAnsiStringConstRef password // password string );
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |