Class CObexClient

class CObexClient : public CObex;

Description

Client side functionality. Connection based. Supports ...

• Opening IrDA TTP sockets for the OBEX session.

• Opening an OBEX session over a connected socket

• Standard OBEX (spec. version 1.2) operations.

This class is not designed for user derivation.

Derivation

• MObexNotify - No description.
• CBase - Base class for all classes to be instantiated on the heap.

• CObex - This class is the common base class for CObexClient and CObexServer. It is an ab...

• CObexClient - Client side functionality. Connection based. Supports ...

Members

Defined in CObexClient:

• Abort()OBEX ABORT operation.
• Connect(CObexBaseObject &,TRequestStatus &)OBEX CONNECT operation to any available remote machine, specifying an object to ...
• Connect(TRequestStatus &)OBEX CONNECT operation to any available remote machine.
• ConnectL(CObexBaseObject &,const TDesC &,TRequestStatus &)OBEX CONNECT operation to any available remote machine, specifying an object to ...
• ConnectL(const TDesC &,TRequestStatus &)OBEX CONNECT operation to any available remote machine, specifying a password.
• ConstructL(TObexTransportInfo &)
• Disconnect(TRequestStatus &)OBEX DISCONNECT operation.
• ExtensionInterface(TUid)Provides additional interfaces for CObexClient.
• Get(CObexBaseObject &,TRequestStatus &)OBEX GET operation.
• GetPutFinalResponseHeaders()This function can be called following the successful completion of a Put, and wi...
• LastServerResponseCode()constGet last server response code This method returns the last received OBEX respons...
• NewL(TObexProtocolInfo &)Allocates and constructs a new OBEX client object.
• NewL(TObexProtocolInfo &,TObexProtocolPolicy &)Allocates and constructs a new OBEX client object with packet sizing information...
• NewL(TObexTransportInfo &)Allocates and constructs a new OBEX client object with packet sizing information...
• OnError(TInt)
• OnPacketReceive(CObexPacket &)
• OnTransportDown()
• OnTransportUp()
• ParseConnectPacket(CObexPacket &)
• Put(CObexBaseObject &,TRequestStatus &)OBEX PUT operation.
• SetCommandTimeOut(TTimeIntervalMicroSeconds32)Sets the Command Idle Time-out.
• SetFinalPacketObserver(MObexFinalPacketObserver *)Sets a final packet observer.
• SetPath(TSetPathInfo &,TRequestStatus &)OBEX SETPATH operation.
• UserPasswordL(const TDesC &)A call back from the the service with the password required for use with generat...
• ~CObexClient()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CObex:

• ConnectState()constThis function is in the protected scope of CObex and so is not externally usable...
• EChallConnChallIssuedConnect with Auth has been sent by Client/Received by Server
• EChallConnRequestedServer, received Simple Connect but Server Challenge issued
• EConnChallRxedConnect without Auth has been sent by ClientReceived by Server
• EConnIdle
• EConnObexTransport Link connected not yet established true Link
• EConnTransportNothing is happening
• EDropLinkdrop the link
• EFinalChallRxedServer, the final response has been received
• EFinalResponseReceivedClient, waiting for final success/fail not chall-response expected Server, Waiti...
• EObexNoSuppressedAuthElements
• EObexSuppressAllAuthElements
• EObexSuppressChallengeOptionsAuthElement
• EObexSuppressRealmAuthElement
• EOpAbortSetPath
• EOpAbortNoFBitAbort - must fit in one pkt so final bit is always set
• EOpConnect
• EOpDisconnectConnect
• EOpGetPut
• EOpGetResponseAbort (internal, never transmitted)
• EOpIdleInternal - not actually an obex operation.
• EOpPutDisconnect
• EOpSetPathGet
• ESimpleConnChallIssuedServer has issued a challenge, to a Client cionnect
• ESimpleConnRequestfull connection established
• EWaitForFinalResponseServer has sent a Challenge & Resp to a Client EChallConnRequest
• EWaitForUserInputServer, Client connect with challenge, Server responds with challenge, Client re...
• IsAuthenticating()constIndicates if the Server / Client is currently authenticating the OBEX connection...
• IsConnected()constReturns ETrue if this CObex is connected at an OBEX level, merely having a trans...
• IsStrictPeer()const
• LocalInfo()constUse this member to gain access to (and alter, if necessary) the CObex::TConnectI...
• RemoteAddr(TSockAddr &)Get the socket address of the remote device.
• RemoteInfo()constUse this member to read the details of the remote machine’s connection informat...
• SetCallBack(MObexAuthChallengeHandler &)Sets the authentication challenge handler.
• SetLocalWho(const TDesC8 &)Sets the local Who field.
• SuppressAuthenticationHeaderElements(TObexSuppressedAuthElements)Must be called by an application that wishes to suppress the authentication or(n...
• TConnectStateCurrent obex connection state In general, the further through the enum the value...
• TObexSuppressedAuthElementsFlags to suppress the authentication elements of the authentication challenge he...
• TOperationThe Obex operation currently being performed.
• TSetPathInfoDescribes the information set or received in a SETPATH command.
• iAuthEngine
• iCallBack
• iChallPassword
• iChallenge
• iConnectState
• iCurrentOperation
• iIncomingChallResp
• iIncomingNonce
• iIncomingRequestDigest
• iLocalInfo
• iNotifyHandler
• iOutgoingChallResp
• iOutgoingNonce
• iRemoteInfo
• iRemoteRealm
• iRemoteUID
• iReserved
• iRespPassword
• iRxChallenge
• iSuppressedObexAuthElements
• iTransportController
• iUserIDRequested

IMPORT_C ~CObexClient();

Description

Destructor.

IMPORT_C static CObexClient* NewL(TObexProtocolInfo &aObexProtocolInfoPtr);

Description

Allocates and constructs a new OBEX client object.

The received protocol information object, aObexProtocolInfoPtr, specifies the transport protocol to use: For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo for Bluetooth, TObexUsbProtocolInfo for USB.

Parameters

Return value

IMPORT_C static CObexClient* NewL(TObexProtocolInfo &aObexProtocolInfoPtr, TObexProtocolPolicy &aObexProtocolPolicy);

Description

Allocates and constructs a new OBEX client object with packet sizing information.

The received protocol information object, aObexProtocolInfoPtr, specifies the transport protocol to use: For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo for Bluetooth, TObexUsbProtocolInfo for USB.

The aObexProtocolPolicy parameter specifies the packet sizing policy for this OBEX object.

Parameters

Return value

IMPORT_C static CObexClient* NewL(TObexTransportInfo &aObexTransportInfo);

Description

Allocates and constructs a new OBEX client object with packet sizing information.

The received transport information object, aObexTransportInfo, specifies the transport protocol packet sizes to use: For the standard transports the following are used, TObexIrProtocolInfo for IrDA, TObexBluetoothProtocolInfo for Bluetooth, TObexUsbProtocolInfo for USB.

Parameters

Return value

private: virtual void ConstructL(TObexTransportInfo &aObexTransportInfo);

Description

Parameters

IMPORT_C void Connect(TRequestStatus &aStatus);

Description

OBEX CONNECT operation to any available remote machine.

Parameters

IMPORT_C void Connect(CObexBaseObject &aObject, TRequestStatus &aStatus);

Description

OBEX CONNECT operation to any available remote machine, specifying an object to pass.

Parameters

IMPORT_C void ConnectL(CObexBaseObject &aObject, const TDesC &aPassword, TRequestStatus &aStatus);

Description

OBEX CONNECT operation to any available remote machine, specifying an object to pass and a password.

Parameters

IMPORT_C void ConnectL(const TDesC &aPassword, TRequestStatus &aStatus);

Description

OBEX CONNECT operation to any available remote machine, specifying a password.

Parameters

IMPORT_C void Disconnect(TRequestStatus &aStatus);

Description

OBEX DISCONNECT operation.

This terminates the OBEX connection, and closes the transport on receiving any response from the server.

Parameters

IMPORT_C void Put(CObexBaseObject &aObject, TRequestStatus &aStatus);

Description

OBEX PUT operation.

Any valid header that is also present in aObject’s header mask will be sent to the server, along with the object body specified by the implementation of aObject.

Parameters

IMPORT_C void Get(CObexBaseObject &aObject, TRequestStatus &aStatus);

Description

OBEX GET operation.

The caller specifies in aObject the headers to send to the server to specify the object to get: normally just a name is expected. If the server can serve the request, the object it returns will be loaded into aObject on completion. All headers returned by the server that are also allowed by the object’s header mask will be loaded into the relevant attributes of aObject. Any object body is stored according to the implementation type of the CObexBaseObject passed.

Parameters

IMPORT_C void SetPath(TSetPathInfo &aPathInfo, TRequestStatus &aStatus);

Description

OBEX SETPATH operation.

This changes the remote device's current path.

Parameters

IMPORT_C void Abort();

Description

OBEX ABORT operation.

The function sends the OBEX abort command to the remote machine if a multi-packet operation (i.e. PUT or GET) is in progress. An operation in progress will complete with KErrAbort.

IMPORT_C virtual void UserPasswordL(const TDesC &aPassword);

Description

A call back from the the service with the password required for use with generating the challenge response.

Parameters

Leave codes

IMPORT_C const CObexHeaderSet& GetPutFinalResponseHeaders();

Description

This function can be called following the successful completion of a Put, and will return a reference to a CObexHeaderSet containing all the headers that were contained in the final Put response packet returned from the peer Obex server.

The headers in the header set will be deleted by any subsequent call to CObexClient functions that trigger Obex commands (ie. Connect, Disconnect, Put, Get, SetPath).

The reference should not be retained beyond the end of the lifetime of the CObexClient object.

Return value

IMPORT_C void SetFinalPacketObserver(MObexFinalPacketObserver *aObserver);

Description

Sets a final packet observer.

This replaces any previous observer. The observer will receive a callback when a final packet for a put or get request begins to be sent and another when the send completes. Although the start and finish callbacks are guaranteed to be in order, no guarantees are made about the ordering with respect to the completion of the put or get request.

This does not transfer ownership.

Parameters

IMPORT_C TObexResponse LastServerResponseCode() const;

Description

Get last server response code This method returns the last received OBEX response code. The method must not be called prior to a response notification being received by the client application. If the method is called a panic will be raised.

Return value

Panic codes

IMPORT_C void SetCommandTimeOut(TTimeIntervalMicroSeconds32 aTimeOut);

Description

Sets the Command Idle Time-out.

This function sets the timer period to be observed during the progress of all OBEX commands. If the OBEX server does not respond within the set period the current OBEX command will be completed with an error of KErrIrObexRespTimedOut and the transport will be disconnected.

Setting a time-out value of 0, all OBEX commands will be allowed to continue indefinitely.

Parameters

IMPORT_C TAny* ExtensionInterface(TUid aUid);

Description

Provides additional interfaces for CObexClient.

Parameters

Return value

private: virtual void OnPacketReceive(CObexPacket &aPacket);

Description

Parameters

private: virtual void OnError(TInt aError);

Description

Parameters

private: virtual void OnTransportUp();

Description

private: virtual void OnTransportDown();

Description

private: virtual TInt ParseConnectPacket(CObexPacket &aPacket);

Description

Parameters

Return value