![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
class CObex : public CBase, protected MObexNotify;
This class is the common base class for CObexClient and CObexServer. It is an abstract class and cannot be instantiated in itself. However, it does contain user functionality common to both
client and server connections.
Provides the basic OBEX transport functionality (sending and receiving files) Client and server provide the more specialied APIs for
initiation or response to puts & gets
(possible) handling of more generalised 'objects' (prob. with data buffered through a file).
This class is not designed for user 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...
Defined in CObex:
ConnectState()constThis function is in the protected scope of CObex and so is not externally usable...ConstructL(TObexTransportInfo &)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 EConnIdleEConnObexTransport 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...EObexNoSuppressedAuthElementsEObexSuppressAllAuthElementsEObexSuppressChallengeOptionsAuthElementEObexSuppressRealmAuthElementEOpAbortSetPath EOpAbortNoFBitAbort - must fit in one pkt so final bit is always set EOpConnectEOpDisconnectConnect 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()constLocalInfo()constUse this member to gain access to (and alter, if necessary) the CObex::TConnectI...OnError(TInt)OnPacketReceive(CObexPacket &)OnTransportDown()OnTransportUp()ParseConnectPacket(CObexPacket &)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.UserPasswordL(const TDesC &)iAuthEngineiCallBackiChallPasswordiChallengeiConnectStateiCurrentOperationiIncomingChallRespiIncomingNonceiIncomingRequestDigestiLocalInfoiNotifyHandleriOutgoingChallRespiOutgoingNonceiRemoteInfoiRemoteRealmiRemoteUIDiReservediRespPasswordiRxChallengeiSuppressedObexAuthElementsiTransportControlleriUserIDRequested~CObex()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...protected: virtual void ConstructL(TObexTransportInfo &aObexTransportInfo);
|
|
|
IMPORT_C void SetCallBack(MObexAuthChallengeHandler &aCallBack);
Sets the authentication challenge handler.
The caller must supply a MObexAuthChallengeHandler implementation to handle calls from the Server/Client for a request for a password.
|
IMPORT_C TBool IsConnected() const;
Returns ETrue if this CObex is connected at an OBEX level, merely having a transport connected does not satisfy this condition. I.e. the two devices must have completed the OBEX connection request/response . All other states return EFalse. This will be unreliable if either the server blindly returns the client’s who header (always reporting ETrue), or if neither supply "who" headers (always reporting EFalse).
|
IMPORT_C TBool IsStrictPeer() const;
|
IMPORT_C const TObexConnectInfo& LocalInfo() const;
Use this member to gain access to (and alter, if necessary) the CObex::TConnectInfo structure which will be sent to the OBEX peer as part of the connection process. Only alter the contents of this having read and understood the purpose of the fields, as defined in the OBEX spec. Altering this structure after a connection has been made will have no effect on the current session, but will be used for future connection attempts.
|
IMPORT_C TInt SetLocalWho(const TDesC8 &aInfo);
Sets the local Who field.
This is used to identify the local end of the OBEX session when the OBEX connection is made. If it is required, set it before establishing the connection.
|
|
IMPORT_C const TObexConnectInfo& RemoteInfo() const;
Use this member to read the details of the remote machine’s connection information, as specified by it in during OBEX connection. This data can not be altered, as this serves no purpose. The content of this structure is undefined when
|
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
CObex::IsConnected()constReturns ETrue if this CObex is connected at an OBEX level, merely having a trans...EFalseDefines the value false that is passed to a TBool type. IMPORT_C void SuppressAuthenticationHeaderElements(TObexSuppressedAuthElements aSuppressedObexAuthElements);
Must be called by an application that wishes to suppress the authentication or(not excusive) the realm of the authentication challenge
|
|
virtual void UserPasswordL(const TDesC &aPassword)=0;
|
IMPORT_C void RemoteAddr(TSockAddr &anAddr);
Get the socket address of the remote device.
This is the address of the device OBEX is connected to over an IrDA or Bluetooth socket.
|
IMPORT_C TBool IsAuthenticating() const;
Indicates if the Server / Client is currently authenticating the OBEX connection.
|
protected: virtual TInt ParseConnectPacket(CObexPacket &aPacket)=0;
|
|
protected: IMPORT_C TConnectState ConnectState() const;
This function is in the protected scope of CObex and so is not externally usable
|
protected: virtual void OnPacketReceive(CObexPacket &aPacket)=0;
|
|
|
class TSetPathInfo;
Describes the information set or received in a SETPATH command.
The first bit of iFlags, 0, can be set to indicate to the receiver of SETPATH to backup a level before applying the path name.
The second bit of iFlags, 1, can be set to indicate to the receiver of SETPATH to NOT create the directory if it doesn't exist.
The iConstants variable is always set to zero as it is reserved. The iName variable indicates the directory to create or go
to, and does not include the root directory of the receiver (i.e. if the directory to be set is C: then iName is set to "notes").
If a name is not set then set CObex::TSetPathInfo::iNamePresent to false.
Defined in CObex::TSetPathInfo:
Parent()constReturns true if the flags are set so that the receiver will backup a level befor...TSetPathInfo()Constructor.iConstantsiFlagsiNameiNamePresentWhether iName is present in this SETPATH info TSetPathInfo()IMPORT_C TSetPathInfo();
Constructor.
This is the path information used in the SETPATH command. The variable iFlags is set to zero by default. The variable iConstants is always set to zero as this is a reserved varaible. The path name is NOT present by default.
Parent()constIMPORT_C TBool Parent() const;
Returns true if the flags are set so that the receiver will backup a level before applying the path name
|
iFlagsTUint8 iFlags;
iConstantsTUint8 iConstants;
iNameTBuf< KObexObjectDescriptionSize > iName;
iNamePresentTBool iNamePresent;
Whether iName is present in this SETPATH info
|
|
TConnectState
Current obex connection state In general, the further through the enum the values are, the further through the connection process the state machine will be.
|
TOperation
The Obex operation currently being performed.
|
TObexSuppressedAuthElements
Flags to suppress the authentication elements of the authentication challenge header.
|
|
|
protected: TUint iSuppressedObexAuthElements;
|
Copyright © 2005-2008 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)