williamr@2: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: #ifndef __BTCMTM_H__
williamr@2: #define __BTCMTM_H__
williamr@2: 
williamr@2: #include <obexclientmtm.h>
williamr@2: 
williamr@2: 
williamr@2: /* This defines the maximum length that the connection password can be for BlueTooth.  The PDU used for this
williamr@2:    has a payload of 16 bytes.
williamr@2: */
williamr@2: #define KBlueToothObexPasswordLength 16
williamr@2: const TInt KBlueToothObexDeviceAddressLength = 6; 	// 6 byte device address
williamr@2: 
williamr@2: extern const TUint8 KObexConnectionIDHeader;
williamr@2: 
williamr@2: class CBtClientMtm : public CObexClientMtm
williamr@2: /**
williamr@2: Bluetooth Client MTM.
williamr@2: 
williamr@2: Provides client-side functionality for bluetooth messaging. This is a thin implementation over the top of
williamr@2: CObexClientMtm.
williamr@2: 
williamr@2: @publishedPartner
williamr@2: @released
williamr@2: */
williamr@2: 	{
williamr@2: public:
williamr@2: 
williamr@2: 	/**
williamr@2: 	 * Canonical NewL factory function. 
williamr@2: 	 *
williamr@2: 	 * @param aRegisteredMtmDll Reference to registration data for MTM DLL.
williamr@2: 	 * @param aMsvSession Reference to CMsvSession of the client requesting the object.	
williamr@2: 	 * @return Pointer to a new, constructed CBtClientMtm
williamr@2: 	 * @leave Leaves if no memory is available.
williamr@2: 	 */
williamr@2: 	IMPORT_C static CBtClientMtm* NewL(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);
williamr@2: 
williamr@2: 	/// Contains the timeout values for connect and put operations
williamr@2: 	struct STimeouts
williamr@2: 		{
williamr@2: 		TInt iConnectTimeout; ///< Connection attempt timeout in microseconds
williamr@2: 		TInt iPutTimeout;	  ///< Put attempt timeout in microseconds
williamr@2: 		};
williamr@2: 	
williamr@2: 	/// Structure for parameter needed for sending via Bluetooth
williamr@2: 	struct SBtcCmdSendParams
williamr@2: 		{
williamr@2: 		STimeouts iTimeouts; ///< Structure containing connect and put operation timeouts
williamr@2: 		TInt iRemoteObexPort; ///< The value of the remote obex port
williamr@2: 		TDesC* iConnectPassword; ///<password sent to the remote server for a client initiated obex authentication challenge
williamr@2: 		};
williamr@2: 		
williamr@2: 	/// Internal version of SBtcCmdSendParams 
williamr@2: 	struct SBtcCmdSendServerParams
williamr@2: 		{
williamr@2: 		STimeouts iTimeouts; ///< Structure containing connect and put operation timeouts
williamr@2: 		TInt iRemoteObexPort; ///< The value of the remote obex port
williamr@2: 		TBufC<KBlueToothObexPasswordLength> iConnectPassword; ///<password sent to the remote server for a client initiated obex authentication challenge 
williamr@2: 		};
williamr@2: 
williamr@2: 	// --- RTTI functions ---
williamr@2: 	
williamr@2: 	/**
williamr@2: 	 * Starts an asynchronous function as an active object. Only works for EBtcCmdSend.
williamr@2: 	 *
williamr@2: 	 * @param aFunctionId Identifier of the function to be invoked. Only supports EBtcCmdSend.
williamr@2: 	 * @param aSelection Selction of message entries for the requested function to operate on.
williamr@2: 	 * @param aParameter Buffer containing input and output parameters.
williamr@2: 	 * @param aCompletionStatus Canonical TRequestStatus used for control of the active object.
williamr@2: 	 * @return Pointer to a new asynchronously completing CMsvOperation. If failed, this is a completed operation with 
williamr@2: 	 * status set to the relevant error code.
williamr@2: 	 * @leave Leaves if no memory is available, or if the specified aFunctionId is unsupported.
williamr@2: 	 */
williamr@2: 
williamr@2: 	virtual CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId,const CMsvEntrySelection& aSelection, TDes8& aParameter, TRequestStatus& aCompletionStatus); //aParameter should package up SBtcCmdSendParams
williamr@2: 
williamr@2: 	/**
williamr@2: 	Add a Bluetooth addressee
williamr@2: 
williamr@2: 	@param anAddressee Addressee field of the following format
williamr@2: 
williamr@2: 
williamr@2: 	_LIT(KTestAddressee1, "XXX:\1Password:\2AA:\3BB");
williamr@2: 
williamr@2: 	_LIT(KTestAddressee2, "XXX:\1Password:\2AA");
williamr@2: 
williamr@2: 	_LIT(KTestAddressee3, "XXX:\1Password");
williamr@2: 
williamr@2: 	_LIT(KTestAddressee4, "XXX");
williamr@2: 
williamr@2: 
williamr@2: 	XXX		: BT device address (6 bytes)
williamr@2: 	:\1		: Password tag sequence (4 bytes) [EBtClientMtmAddresseeFieldTypePassword]
williamr@2: 	Password	: 0-16 characters (0-32 bytes)
williamr@2: 	:\2		: Connection timeout tag sequence (4 bytes) [EBtClientMtmAddresseeFieldTypeConnectionTimeout]
williamr@2: 	AA		: Connection timeout (1 TInt = 4 bytes) 
williamr@2: 	:\3		: Put timeout tag sequence (4 bytes) [EBtClientMtmAddresseeFieldTypePutTimeout]
williamr@2: 	BB		: Put timeout (1 TInt = 4 bytes)
williamr@2: 	 
williamr@2: 	@leave Leaves with KErrArgument if addresse badly formatted or corrupt.
williamr@2: 	 */
williamr@2: 	virtual void AddAddresseeL(const TDesC& anAddressee);
williamr@2: 
williamr@2: private:
williamr@2: 	/*
williamr@2: 	 * Addressee field tags
williamr@2: 	 * Note: The EAlternativeConnectTimeout exists because in an older version of
williamr@2: 	 * the code, we were looking for the wrong field tag in the addressee field to
williamr@2: 	 * get the connect timeout value. We should have been looking for the ETimeout value
williamr@2: 	 * from this Enum, but instead we were incorrectly using a constant defined elsewhere.
williamr@2: 	 * The incorrectly used constant had a value of 0x08. In order to remain backward
williamr@2: 	 * compatible, we now look for both constants.
williamr@2: 	 */
williamr@2: 	enum TBtClientMtmAddresseeFieldType
williamr@2: 		{
williamr@2: 		EDeviceAddress,
williamr@2: 		EPassword,
williamr@2: 		ETimeout,
williamr@2: 		EPutTimeout,
williamr@2: 		EAlternativeConnectTimeout = 0x08
williamr@2: 		};
williamr@2: 	
williamr@2: 	/**
williamr@2: 	 * Constructor--not for use by client applications
williamr@2: 	 *
williamr@2: 	 * @param aRegisteredMtmDll Registration data for MTM DLL.
williamr@2: 	 * @param aMsvSession CMsvSession of the client requesting the object. 
williamr@2: 	 */
williamr@2: 
williamr@2: 	CBtClientMtm(CRegisteredMtmDll& aRegisteredMtmDll, CMsvSession& aMsvSession);
williamr@2: 	
williamr@2: 	/**
williamr@2: 	 * Deletes the old header, then creates a new CBtHeader.
williamr@2: 	 *
williamr@2: 	 * @leave KErrXXX System-wide error codes if allocation fails
williamr@2: 	 */
williamr@2: 	
williamr@2: 	virtual void InitialiseHeaderL();
williamr@2: 	
williamr@2: 	TBool ParseDestinationFieldL(TUint16 aFieldTag, TDes8& aField, TPtrC& aFieldList);
williamr@2: 	void ParseDestinationL(const TDesC& aFieldsToParse, TDes8& aDeviceAddress, 
williamr@2: 						 TDes16& aPassword, TInt& aConnectTimeout, TInt& aPutTimeout);
williamr@2: 	void CreateMessageOperationL(CMsvOperation*& aOperation, 
williamr@2: 		const CMsvEntrySelection& aSelection, TRequestStatus& aCompletionStatus);
williamr@2: 
williamr@2: 
williamr@2: #ifdef _DEBUG
williamr@2: 	virtual void TestInvariant() const;
williamr@2: #endif //_DEBUG
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: #endif // __BTCMTM_H__