API_REF/Public_API: comparison epoc32/include/btdevice.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
 // All rights reserved.
 // This component and the accompanying materials are made available
-// 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
+// under the terms of "Eclipse Public License v1.0"
 // which accompanies this distribution, and is available
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
 //
 // Initial Contributors:
 // Nokia Corporation - initial contribution.
 //
 // Contributors:
 @publishedAll
 @released
 **/
 static const TInt KMaxFriendlyNameLen = 100;
-/** Length of a bluetooth device name. Retained for binary compatibility.
+/** Length of a bluetooth device name. This is not to be used outside of the sub-system. Retained for binary compatibility.
 @internalComponent
 @deprecated
 **/
 static const TInt KMaxBCBluetoothNameLen = 256;
 	{
 public:
 	IMPORT_C static TBTDeviceName ToUnicodeL(const TBTDeviceName8& aName);
 	IMPORT_C static TBTDeviceName8 ToUTF8L(const TBTDeviceName& aName);
 	};
-/** Defines the granularity of the arrays used in CBTDevice.
-@internalComponent
-@released
-**/
-const TInt KSecurityGranularity=1;
 /** Cleanup utility for CBTDeviceArrays.
 Creates a TCleanupItem that calls ResetAndDestroy and then deletes the array.
 	/** Controller toy device **/
 	EMinorDeviceToyController = 0x04,			//000100
 	/** Game toy device **/
 	EMinorDeviceToyGame = 0x05,					//000101
 	};
-/** Minor Device class headset.
-@deprecated
-@internalComponent
-@see TBTMinorDeviceClassAV
-**/
-enum TBTMinorDeviceClassHeadset
-	{										//7    2
-	EHeadsetUnclassified = 0x0,				//000000
-	EHeadsetProfile = 0x1,					//000001
-	};
 /** Encapsulation of device class definitions.
 Contains a single TInt as member data and methods to extract the major, minor and service
 class information from that TInt.
 	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
 	IMPORT_C void InternalizeL(RReadStream& aStream);
 private:
 	static const TUint32 KStreamVersion = 0x00000001;
 private:
-	TUint32 iDeviceClass;
+	TUint32	iDeviceClass;
 	// This data padding has been added to help prevent future binary compatibility breaks
 	// Neither iPadding1 nor iPadding2 have been zero'd because they are currently not used
-	TUint32     iPadding1;
+	TUint32	iPadding1;
-	TUint32     iPadding2;
+	TUint32	iPadding2;
 	};
 /** Class to store the security override parameters for a particular remote device.
 @publishedAll
 public:
 	/** Enumeration to assist in parsing of security settings. */
 	enum TBTDeviceSecuritySettings
 		{
-		ENoAuthenticate	= 0x01, /*!< Don't authenticate the link */
+		ENoAuthenticate			= 0x01, /*!< Don't authenticate the link @deprecated */
-		ENoAuthorise = 0x02, /*!< Don't authorise the connection */
+		ENoAuthorise			= 0x02, /*!< Don't authorise the connection */
-		EEncrypt = 0x04, /*!< Encrypt the link */
+		EEncrypt				= 0x04, /*!< Encrypt the link */
 		EBanned					= 0x08, /*!< Don't connect to the device */
 		EMitmProtectionRequired	= 0x10, /*!< Require the link is MITM protected */
 		};
 private:
 	static const TUint32 KStreamVersion = 0x00000001;
 private:
-	TUint8 iSecurity;
+	TUint8	iSecurity;
-	TUint  iPasskeyMinLength;
+	TUint	iPasskeyMinLength;
 	// This data padding has been added to help prevent future binary compatibility breaks
 	// Neither iPadding1 nor iPadding2 have been zero'd because they are currently not used
-	TUint32     iPadding1;
+	TUint32	iPadding1;
-	TUint32     iPadding2;
+	TUint32	iPadding2;
 	};
 /** Class to tie a service uid with a device security setting.
 This allows us to have service-specific security settings for a device.
 	TBTDevAddr			iDeviceAddress;		/*!< the address of the device for the overriding security **/
 	TBTDeviceSecurity	iDeviceSecurity;	/*!< the overriding security */
 	// This data padding has been added to help prevent future binary compatibility breaks
 	// Neither iPadding1 nor iPadding2 have been zero'd because they are currently not used
-	TUint32     iPadding1;
+	TUint32		iPadding1;
-	TUint32     iPadding2;
+	TUint32		iPadding2;
 	};
-/** For Symbian use only
-@internalAll
-*/
-NONSHARABLE_CLASS(TBTBasebandParameters)
-	{
-public:
-	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
-	IMPORT_C void InternalizeL(RReadStream& aStream);
-	TUint8 iPageScanRepetitionMode;			/*!< Page Scan repetition mode of remote device ( valid if > 0 ) */
-	TUint8 iPageScanPeriodMode;				/*!< Page scan period mode of remote device */
-	TUint8 iPageScanMode;					/*!< Page scan mode of remote device ( valid if > 0 ) */
-	TUint16 iClockOffset;					/*!< clock off set of remote device ( valid if > 0 ) */
-private:
-	static const TUint32 KStreamVersion = 0x00000001;
-	};
 /** Stores parameters for a nameless device.
 A class which stores useful parameters concerning a remote device
 But *not* including names
 @released
 */
 NONSHARABLE_CLASS(TBTNamelessDevice)
 	{
 friend class CBTDevice;
-public:
+private:
-	IMPORT_C TBTNamelessDevice();
+	/** For Symbian use only
-	IMPORT_C const TBTDevAddr& Address() const;
+	@internalComponent
-	IMPORT_C const TBTDeviceClass& DeviceClass() const;
+	*/
-	IMPORT_C const TBTLinkKey& LinkKey() const;
+	NONSHARABLE_CLASS(TBTBasebandParameters)
+		{
+	public:
+		void ExternalizeL(RWriteStream& aStream) const;
+		void InternalizeL(RReadStream& aStream);
+		TUint8 iPageScanRepetitionMode;			/*!< Page Scan repetition mode of remote device ( valid if > 0 ) */
+		TUint8 iPageScanPeriodMode;				/*!< Page scan period mode of remote device */
+		TUint8 iPageScanMode;					/*!< Page scan mode of remote device ( valid if > 0 ) */
+		TUint16 iClockOffset;					/*!< clock off set of remote device ( valid if > 0 ) */
+	private:
+		static const TUint32 KStreamVersion = 0x00000001;
+		};
+public:
+	IMPORT_C TBTNamelessDevice();
+	IMPORT_C const TBTDevAddr& Address() const;
+	IMPORT_C const TBTDeviceClass& DeviceClass() const;
+	IMPORT_C const TBTLinkKey& LinkKey() const;
 	IMPORT_C TBTLinkKeyType LinkKeyType() const;
 	IMPORT_C TUint8 PageScanRepMode() const;
 	IMPORT_C TUint8 PageScanMode() const;
 	IMPORT_C TUint8 PageScanPeriodMode() const;
 	IMPORT_C TUint16 ClockOffset() const;
 	IMPORT_C const TTime& Seen() const;
 	IMPORT_C const TTime& Used() const;
 	IMPORT_C const TBTDeviceSecurity& GlobalSecurity() const;
 	IMPORT_C void SetAddress(const TBTDevAddr& aBDAddr);
 	IMPORT_C void SetDeviceClass(TBTDeviceClass aDeviceClass);
 	IMPORT_C void SetLinkKey(const TBTLinkKey& aLinkKey);
 	IMPORT_C void SetLinkKey(const TBTLinkKey& aLinkKey, TBTLinkKeyType aLinkKeyType);
 	IMPORT_C void SetPageScanRepMode(TUint8 aPageScanRepMode);
 	IMPORT_C void SetPageScanPeriodMode(TUint8 aPageScanPeriodMode);
 	IMPORT_C void SetPageScanMode(TUint8 aPageScanMode);
 	IMPORT_C void SetClockOffset(TUint16 aClockOffSet);
 	IMPORT_C void SetGlobalSecurity(const TBTDeviceSecurity& aSetting);
 	IMPORT_C void SetUsed(const TTime& aDateTime);
 	IMPORT_C void SetSeen(const TTime& aDateTime);
 	IMPORT_C TBool IsValidAddress() const;
 	IMPORT_C TBool IsValidDeviceClass() const;
 	IMPORT_C TBool IsValidLinkKey() const;
 	IMPORT_C TUint CompareTo(const TBTNamelessDevice& aDevice) const;
 	IMPORT_C TBool IsPaired() const;
 	IMPORT_C void SetPaired(TBool aPaired);
 	IMPORT_C void SetPaired(TBTLinkKeyType aLinkKeyType);
 	IMPORT_C TBool IsValidPaired() const;
 	IMPORT_C const TBTPinCode& PassKey() const;
 	IMPORT_C void  SetPassKey(const TBTPinCode& aPassKey);
 	IMPORT_C TBool IsValidPassKey() const;
 	IMPORT_C TUint PassKeyLength() const;
 	IMPORT_C TBool IsValidUiCookie() const;
 	IMPORT_C void SetUiCookie(TUint32 aUiCookie);
 	IMPORT_C TUint32 UiCookie() const;
 	/**	Bitfield of TBTNamelessDevice attributes
+	This enum is to only be used by phone manufacturers, not by application developers.
 	@publishedPartner
 	@released
 	*/
 	enum TBTDeviceSet
 		{
-		EAddress				= 0x000001, /*!< Device address */
+		EAddress				=	0x000001, /*!< Device address */
-		EDeviceClass			= 0x000002, /*!< Device class */
+		EDeviceClass			=	0x000002, /*!< Device class */
-		ELinkKey				= 0x000004, /*!< Link key */
+		ELinkKey				=	0x000004, /*!< Link key */
-		EGlobalSecurity			= 0x000008, /*!< Global security settings */
+		EGlobalSecurity			=	0x000008, /*!< Global security settings */
-		EPageScanRepMode		= 0x000010, /*!< Page scan repition mode */
+		EPageScanRepMode		=	0x000010, /*!< Page scan repition mode */
-		EPageScanMode           = 0x000020, /*!< Page scan mode */
+		EPageScanMode			=	0x000020, /*!< Page scan mode */
-		EPageScanPeriodMode     = 0x000040, /*!< Page scan period */
+		EPageScanPeriodMode		=	0x000040, /*!< Page scan period */
-		EClockOffset			= 0x000080, /*!< Clock offset */
+		EClockOffset			=	0x000080, /*!< Clock offset */
-		EUsed					= 0x000100, /*!< Last used */
+		EUsed					=	0x000100, /*!< Last used */
-		ESeen					= 0x000200, /*!< Last seen */
+		ESeen					=	0x000200, /*!< Last seen */
-		EIsPaired				= 0x000400, /*!< Is paired */
+		EIsPaired				=	0x000400, /*!< Is paired */
-		EPassKey				= 0x000800, /*!< PassKey */
+		EPassKey				=	0x000800, /*!< PassKey */
 		EUiCookie				=	0x001000, /*!< User interface specific cookie */
 		EAllNamelessProperties	= 0x00ffffff, /*!< All nameless properties set */
 		// Two highest nibbles used by CBTDevice
 		};
 	TBTDeviceSecurity		iGlobalSecurity;/*!< The overall security criteria for all services which this device may wish to use */
 	TBTBasebandParameters	iBasebandParams;/*!< The baseband parameters */
 	TTime					iUsed;			/*!< when last connect from/to */
 	TTime					iSeen;			/*!< when last seen in inquiry */
 	TBool					iPaired;		/*!< Whether this device is paired */
-	TBTPinCode				iPassKey;       /*!< PassKey */
+	TBTPinCode				iPassKey;		/*!< PassKey */
 	TBTLinkKeyType			iLinkKeyType;	/*!< Link Key Type */
 	TUint32					iUiCookie;		/*!< The cookie attached to this device by the UI */
-	// This data padding has been added to help prevent future binary compatibility breaks
+	// This data padding has been added to help prevent future binary compatibility breaks.
 	// iPadding1 has been used for iLinkKeyType
 	// iPadding2 has been used for iUiCookie
-	TUint32     iPadding3;
+	TUint32		iPadding3;
 	TUint32		iPadding4;
 	};
 /** Encapsulates all information that must be known about a device.
 NONSHARABLE_CLASS(CBTDevice) : public CBase
 	{
 friend class TBTNamelessDevice;
 public:
 	IMPORT_C static CBTDevice* NewL(const TBTDevAddr& aBDAddr);
 	IMPORT_C static CBTDevice* NewLC(const TBTDevAddr& aBDAddr);
 	IMPORT_C static CBTDevice* NewL(const TBTNamelessDevice& aNamelessDevice);
 	IMPORT_C static CBTDevice* NewLC(const TBTNamelessDevice& aNamelessDevice);
 	IMPORT_C static CBTDevice* NewL();
 	IMPORT_C static CBTDevice* NewLC();
 	IMPORT_C ~CBTDevice();
 	IMPORT_C CBTDevice* CopyL() const;
 	IMPORT_C void UpdateL(const CBTDevice& aDevice);
 /** Class used to exchange the local settings with the Registry server.
 	Not a complete set of details of the local device
-	@publishedPartner
+	@publishedAll
 	@released
 */
 NONSHARABLE_CLASS(TBTLocalDevice)
 	{
 		EPowerSetting				= 0x0008,
 		EScanEnable					= 0x0010,
 		ELimitedDiscoverable 		= 0x0020,
 		EAFHChannelAssessmentMode	= 0x0040,
 		EAcceptPairedOnlyMode 		= 0x0080,
-		};	///< Used for indicating if a setting has been set (i.e. not a default/random value) @see iBitMask
+		};	//< Used for indicating if a setting has been set (i.e. not a default/random value) @see iBitMask
 private:
 	enum
 		{
 		EAFHChannelAssessmentModeValue	= 0x0001,
 		EAcceptPairedOnlyModeValue		= 0x0002,
-		};	///< Used for settings requiring little space: allows new settings ot be introduced without increasing the size of this class @see iSimpleSettings
+		};	//< Used for settings requiring little space: allows new settings ot be introduced without increasing the size of this class @see iSimpleSettings
-	TUint			iSetMask;		 ///< Bit mask indicating the data members that have been set
+	TUint			iSetMask;		 //< Bit mask indicating the data members that have been set
 	TBTDevAddr		iAddress;
 	TUint32			iCod;
 	TBTDeviceName8	iLocalName;
 	TUint8			iPowerSetting;
 	THCIScanEnable	iScanEnable;
 	TBool			iLimitedDiscoverable;
-	TUint32			iSimpleSettings; ///< Only first two bits currently used - for AFH Channel Assessment Mode, and Accept Paired Only Mode
+	TUint32			iSimpleSettings; //< Only first two bits currently used - for AFH Channel Assessment Mode, and Accept Paired Only Mode
 	};
 #endif

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811