CObexClient Class Reference

class CObexClient : public CObex
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.

Inherits from

Public Member Functions
~CObexClient()
IMPORT_C voidAbort()
IMPORT_C voidConnect(TRequestStatus &)
IMPORT_C voidConnect(CObexBaseObject &, TRequestStatus &)
IMPORT_C voidConnectL(CObexBaseObject &, const TDesC &, TRequestStatus &)
IMPORT_C voidConnectL(const TDesC &, TRequestStatus &)
IMPORT_C voidDisconnect(TRequestStatus &)
IMPORT_C TAny *ExtensionInterface(TUid)
IMPORT_C voidGet(CObexBaseObject &, TRequestStatus &)
IMPORT_C const CObexHeaderSet &GetPutFinalResponseHeaders()
IMPORT_C TObexResponseLastServerResponseCode()
IMPORT_C CObexClient *NewL(TObexProtocolInfo &)
IMPORT_C CObexClient *NewL(TObexProtocolInfo &, TObexProtocolPolicy &)
IMPORT_C CObexClient *NewL(TObexTransportInfo &)
IMPORT_C voidPut(CObexBaseObject &, TRequestStatus &)
IMPORT_C voidSetCommandTimeOut(TTimeIntervalMicroSeconds32)
IMPORT_C voidSetFinalPacketObserver(MObexFinalPacketObserver *)
IMPORT_C voidSetPath(TSetPathInfo &, TRequestStatus &)
voidSignalPacketProcessEvent(TInt)
voidTimeOutCompletion()
IMPORT_C voidUserPasswordL(const TDesC &)
Private Member Functions
CObexClient()
TBool AlreadyActive(TRequestStatus &)
voidClientCommandL(TOperation, TAny *, TRequestStatus &)
voidCompleteRequest(const TInt)
voidConstructL(TObexTransportInfo &)
voidEmptyHeaderSet()
voidOnError(TInt)
voidOnPacketReceive(CObexPacket &)
voidOnTransportDown()
voidOnTransportUp()
TInt ParseConnectPacket(CObexPacket &)
TInt PrepareConnectPacket(CObexPacket &)
voidResetConnectionID()
voidSendRequestPacket()
voidSendRequestPacket(TObexOpcode)
voidSetConnectionID(TUint32)
voidSetRequest(TRequestStatus &, TOperation)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CObex::CObex()
CObex::CancelObexConnection()
CObex::ConnectState()const
CObex::ControlledTransportDown()
CObex::Error(TInt)
CObex::ForcedTransportDown()
CObex::GenerateChallenge(CObexPacket &)
CObex::GetConnectState()const
CObex::IsAuthenticating()const
CObex::IsConnected()const
CObex::IsStrictPeer()const
CObex::LocalInfo()const
CObex::NotifyError(TInt)
CObex::NotifyProcess(CObexPacket &)
CObex::NotifyTransportDown(TBool)
CObex::NotifyTransportUp()
CObex::PrepareChallResponseL(const TDesC &)
CObex::Process(CObexPacket &)
CObex::ProcessChallResponseL(const TObexInternalHeader &)
CObex::ProcessChallengeL(const TObexInternalHeader &)
CObex::RemoteAddr(TSockAddr &)
CObex::RemoteInfo()const
CObex::RemoteInfoCleanup()
CObex::SetCallBack(MObexAuthChallengeHandler &)
CObex::SetConnectState(TConnectState)
CObex::SetLocalWho(const TDesC8 &)
CObex::SuppressAuthenticationHeaderElements(TObexSuppressedAuthElements)
CObex::TransportDown(TBool)
CObex::TransportUp()
CObex::~CObex()
Inherited Enumerations
CObex:TConnectState
CObex:TObexSuppressedAuthElements
CObex:TOperation
Private Attributes
TTimeIntervalMicroSeconds32 iCmdTimeOutDuration
TUint32 iConnectionID
TBool iConnectionIdSet
CObexBaseObject *iCurrentObject
CObexErrorEngine *iErrorEngine
CObexHeader *iHeader
CObexHeaderSet *iHeaderSet
TBool iIsLastErrorSet
TObexResponse iLastReceivedResponseOpcode
CObexPacketSignaller *iPacketProcessSignaller
CObexPacketTimer *iPacketTimer
TRequestStatus *iPendingRequest
Inherited Attributes
CObex::iAuthEngine
CObex::iCallBack
CObex::iChallPassword
CObex::iChallenge
CObex::iConnectState
CObex::iCurrentOperation
CObex::iIncomingChallResp
CObex::iIncomingNonce
CObex::iIncomingRequestDigest
CObex::iLocalInfo
CObex::iNotifyHandler
CObex::iOutgoingChallResp
CObex::iOutgoingNonce
CObex::iRemoteInfo
CObex::iRemoteRealm
CObex::iRemoteUID
CObex::iReserved
CObex::iRespPassword
CObex::iRxChallenge
CObex::iSuppressedObexAuthElements
CObex::iTransportController
CObex::iUserIDRequested

Constructor & Destructor Documentation

CObexClient()

CObexClient()[private]

~CObexClient()

IMPORT_C~CObexClient()

Member Functions Documentation

Abort()

IMPORT_C voidAbort()

AlreadyActive(TRequestStatus &)

TBool AlreadyActive(TRequestStatus &aStatus)[private]

Parameters

TRequestStatus & aStatus

ClientCommandL(TOperation, TAny *, TRequestStatus &)

voidClientCommandL(TOperationaOp,
TAny *aParam,
TRequestStatus &aStatus
)[private]

Parameters

TOperation aOp
TAny * aParam
TRequestStatus & aStatus

CompleteRequest(const TInt)

voidCompleteRequest(const TIntaCompletion)[private]

Parameters

const TInt aCompletion

Connect(TRequestStatus &)

IMPORT_C voidConnect(TRequestStatus &aStatus)

Parameters

TRequestStatus & aStatus

Connect(CObexBaseObject &, TRequestStatus &)

IMPORT_C voidConnect(CObexBaseObject &aObject,
TRequestStatus &aStatus
)

Parameters

CObexBaseObject & aObject
TRequestStatus & aStatus

ConnectL(CObexBaseObject &, const TDesC &, TRequestStatus &)

IMPORT_C voidConnectL(CObexBaseObject &aObject,
const TDesC &aPassword,
TRequestStatus &aStatus
)

Parameters

CObexBaseObject & aObject
const TDesC & aPassword
TRequestStatus & aStatus

ConnectL(const TDesC &, TRequestStatus &)

IMPORT_C voidConnectL(const TDesC &aPassword,
TRequestStatus &aStatus
)

Parameters

const TDesC & aPassword
TRequestStatus & aStatus

ConstructL(TObexTransportInfo &)

voidConstructL(TObexTransportInfo &aObexTransportInfo)[private, virtual]

Parameters

TObexTransportInfo & aObexTransportInfo

Disconnect(TRequestStatus &)

IMPORT_C voidDisconnect(TRequestStatus &aStatus)

Parameters

TRequestStatus & aStatus

EmptyHeaderSet()

voidEmptyHeaderSet()[private]

ExtensionInterface(TUid)

IMPORT_C TAny *ExtensionInterface(TUidaUid)

Parameters

TUid aUid

Get(CObexBaseObject &, TRequestStatus &)

IMPORT_C voidGet(CObexBaseObject &aObject,
TRequestStatus &aStatus
)

Parameters

CObexBaseObject & aObject
TRequestStatus & aStatus

GetPutFinalResponseHeaders()

IMPORT_C const CObexHeaderSet &GetPutFinalResponseHeaders()

LastServerResponseCode()

IMPORT_C TObexResponseLastServerResponseCode()const

NewL(TObexProtocolInfo &)

IMPORT_C CObexClient *NewL(TObexProtocolInfo &aObexProtocolInfoPtr)[static]

Parameters

TObexProtocolInfo & aObexProtocolInfoPtr

NewL(TObexProtocolInfo &, TObexProtocolPolicy &)

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

Parameters

TObexProtocolInfo & aObexProtocolInfoPtr
TObexProtocolPolicy & aObexProtocolPolicy

NewL(TObexTransportInfo &)

IMPORT_C CObexClient *NewL(TObexTransportInfo &aObexTransportInfo)[static]

Parameters

TObexTransportInfo & aObexTransportInfo

OnError(TInt)

voidOnError(TIntaError)[private, virtual]

Parameters

TInt aError

OnPacketReceive(CObexPacket &)

voidOnPacketReceive(CObexPacket &aPacket)[private, virtual]

Parameters

CObexPacket & aPacket

OnTransportDown()

voidOnTransportDown()[private, virtual]

OnTransportUp()

voidOnTransportUp()[private, virtual]

ParseConnectPacket(CObexPacket &)

TInt ParseConnectPacket(CObexPacket &aPacket)[private, virtual]

Parameters

CObexPacket & aPacket

PrepareConnectPacket(CObexPacket &)

TInt PrepareConnectPacket(CObexPacket &aPacket)[private]

Parameters

CObexPacket & aPacket

Put(CObexBaseObject &, TRequestStatus &)

IMPORT_C voidPut(CObexBaseObject &aObject,
TRequestStatus &aStatus
)

Parameters

CObexBaseObject & aObject
TRequestStatus & aStatus

ResetConnectionID()

voidResetConnectionID()[private]

SendRequestPacket()

voidSendRequestPacket()[private]

SendRequestPacket(TObexOpcode)

voidSendRequestPacket(TObexOpcodeaObexOpcode)[private]

Parameters

TObexOpcode aObexOpcode

SetCommandTimeOut(TTimeIntervalMicroSeconds32)

IMPORT_C voidSetCommandTimeOut(TTimeIntervalMicroSeconds32aTimeOut)

Parameters

TTimeIntervalMicroSeconds32 aTimeOut

SetConnectionID(TUint32)

voidSetConnectionID(TUint32aConnectionID)[private]

Parameters

TUint32 aConnectionID

SetFinalPacketObserver(MObexFinalPacketObserver *)

IMPORT_C voidSetFinalPacketObserver(MObexFinalPacketObserver *aObserver)

Parameters

MObexFinalPacketObserver * aObserver

SetPath(TSetPathInfo &, TRequestStatus &)

IMPORT_C voidSetPath(TSetPathInfo &aPathInfo,
TRequestStatus &aStatus
)

Parameters

TSetPathInfo & aPathInfo
TRequestStatus & aStatus

SetRequest(TRequestStatus &, TOperation)

voidSetRequest(TRequestStatus &aStatus,
TOperationaOperation
)[private]

Parameters

TRequestStatus & aStatus
TOperation aOperation

SignalPacketProcessEvent(TInt)

voidSignalPacketProcessEvent(TIntaEvent)

Parameters

TInt aEvent

TimeOutCompletion()

voidTimeOutCompletion()

UserPasswordL(const TDesC &)

IMPORT_C voidUserPasswordL(const TDesC &aPassword)[virtual]

Parameters

const TDesC & aPassword

Member Data Documentation

TTimeIntervalMicroSeconds32 iCmdTimeOutDuration

TTimeIntervalMicroSeconds32 iCmdTimeOutDuration[private]

TUint32 iConnectionID

TUint32 iConnectionID[private]

TBool iConnectionIdSet

TBool iConnectionIdSet[private]

CObexBaseObject * iCurrentObject

CObexBaseObject *iCurrentObject[private]

CObexErrorEngine * iErrorEngine

CObexErrorEngine *iErrorEngine[private]

CObexHeader * iHeader

CObexHeader *iHeader[private]

CObexHeaderSet * iHeaderSet

CObexHeaderSet *iHeaderSet[private]

TBool iIsLastErrorSet

TBool iIsLastErrorSet[private]

TObexResponse iLastReceivedResponseOpcode

TObexResponse iLastReceivedResponseOpcode[private]

CObexPacketSignaller * iPacketProcessSignaller

CObexPacketSignaller *iPacketProcessSignaller[private]

CObexPacketTimer * iPacketTimer

CObexPacketTimer *iPacketTimer[private]

TRequestStatus * iPendingRequest

TRequestStatus *iPendingRequest[private]
© Nokia 2010.