epoc32/include/eui_addr.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/eui_addr.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/eui_addr.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     1.4  // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5  // All rights reserved.
     1.6  // This component and the accompanying materials are made available
     1.7 -// 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
     1.8 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -30,7 +30,7 @@
    1.16  #include "es_sock.h"	// TSockAddr
    1.17  
    1.18  /**  Address family ID */
    1.19 -const TUint KAfEui64	= 0x0F64;	///< TODO
    1.20 +const TUint KAfEui64	= 0x0F64;	//< TODO
    1.21  
    1.22  /**  Panic codes.
    1.23  @publishedAll
    1.24 @@ -56,17 +56,17 @@
    1.25  class TE64Addr
    1.26  {
    1.27   public:
    1.28 -	IMPORT_C TE64Addr();					///< Constructs an address with zero value
    1.29 -	IMPORT_C TE64Addr(const TE64Addr& aAddr);		///< Constructs an address with given value
    1.30 -	IMPORT_C TE64Addr(const TInt64& aAddr);			///< Constructs an address with given value
    1.31 -	IMPORT_C TE64Addr(const TUint8* aPtr, TUint aLength);	///< Constructs an address with given value
    1.32 +	IMPORT_C TE64Addr();					//< Constructs an address with zero value
    1.33 +	IMPORT_C TE64Addr(const TE64Addr& aAddr);		//< Constructs an address with given value
    1.34 +	IMPORT_C TE64Addr(const TInt64& aAddr);			//< Constructs an address with given value
    1.35 +	IMPORT_C TE64Addr(const TUint8* aPtr, TUint aLength);	//< Constructs an address with given value
    1.36  
    1.37 -	IMPORT_C void SetAddr(const TE64Addr& aAddr);			///< Sets the address value
    1.38 -	IMPORT_C void SetAddr(const TInt64& aAddr);			///< Sets the address value
    1.39 -	IMPORT_C void SetAddr(const TUint8* aPtr, TUint aLength);	///< Sets the address value
    1.40 +	IMPORT_C void SetAddr(const TE64Addr& aAddr);			//< Sets the address value
    1.41 +	IMPORT_C void SetAddr(const TInt64& aAddr);			//< Sets the address value
    1.42 +	IMPORT_C void SetAddr(const TUint8* aPtr, TUint aLength);	//< Sets the address value
    1.43  
    1.44  
    1.45 -	IMPORT_C void SetAddrZero();	///< Creates a zero address
    1.46 +	IMPORT_C void SetAddrZero();	//< Creates a zero address
    1.47  
    1.48  	/**
    1.49  	 * Creates a random address.
    1.50 @@ -90,22 +90,22 @@
    1.51  	IMPORT_C void SetAddrRandomNZButNot(const TE64Addr& aAddr);
    1.52  
    1.53  	// Really should define TE48Addr for this... -tom
    1.54 -	IMPORT_C void SetAddrFromEUI48(const TUint8* aPtr);	///< Reads and converts a value from EUI-48 (6 bytes)
    1.55 +	IMPORT_C void SetAddrFromEUI48(const TUint8* aPtr);	//< Reads and converts a value from EUI-48 (6 bytes)
    1.56  
    1.57 -	IMPORT_C void SetGroupBit(TBool aBit = 1);		///< Sets the Group bit to 1 by default
    1.58 -	IMPORT_C void SetUniversalBit(TBool aBit = 1);		///< Sets the Universal bit to 1 by default
    1.59 +	IMPORT_C void SetGroupBit(TBool aBit = 1);		//< Sets the Group bit to 1 by default
    1.60 +	IMPORT_C void SetUniversalBit(TBool aBit = 1);		//< Sets the Universal bit to 1 by default
    1.61  
    1.62 -	IMPORT_C TBool Match(const TE64Addr& aAddr) const;	///< TRUE if the address matches given address
    1.63 -	IMPORT_C TBool IsZero() const;				///< TRUE if the address is a zero address
    1.64 -	IMPORT_C TBool IsGroup() const;				///< TRUE if the Group bit is set in the address
    1.65 -	IMPORT_C TBool IsUniversal() const;			///< TRUE if the Universal bit is set in the address
    1.66 +	IMPORT_C TBool Match(const TE64Addr& aAddr) const;	//< TRUE if the address matches given address
    1.67 +	IMPORT_C TBool IsZero() const;				//< TRUE if the address is a zero address
    1.68 +	IMPORT_C TBool IsGroup() const;				//< TRUE if the Group bit is set in the address
    1.69 +	IMPORT_C TBool IsUniversal() const;			//< TRUE if the Universal bit is set in the address
    1.70  
    1.71 -//	IMPORT_C TInt Input(const TDesC& aBuf);			///< Reads a value for the address from a string
    1.72 -	IMPORT_C void Output(TDes& aBuf) const;			///< Writes the address into a string
    1.73 +//	IMPORT_C TInt Input(const TDesC& aBuf);			//< Reads a value for the address from a string
    1.74 +	IMPORT_C void Output(TDes& aBuf) const;			//< Writes the address into a string
    1.75  	
    1.76 -	IMPORT_C static TUint AddrLen();			///< Returns the size of raw KAfEui64 content format
    1.77 -	IMPORT_C TUint8* AddrPtr();				///< Returns a pointer to raw KAfEui64 content format
    1.78 -	IMPORT_C const TUint8* AddrPtrC() const;		///< Returns a const pointer to raw KAfEui64 content format
    1.79 +	IMPORT_C static TUint AddrLen();			//< Returns the size of raw KAfEui64 content format
    1.80 +	IMPORT_C TUint8* AddrPtr();				//< Returns a pointer to raw KAfEui64 content format
    1.81 +	IMPORT_C const TUint8* AddrPtrC() const;		//< Returns a const pointer to raw KAfEui64 content format
    1.82  
    1.83   private:
    1.84  	union
    1.85 @@ -117,7 +117,7 @@
    1.86  };
    1.87  
    1.88  struct SE64Addr {
    1.89 -	TE64Addr iAddr;		///< 8 bytes of Modified EUI-64 address (64 bits)
    1.90 +	TE64Addr iAddr;		//< 8 bytes of Modified EUI-64 address (64 bits)
    1.91  };
    1.92  
    1.93  /**
    1.94 @@ -174,17 +174,17 @@
    1.95  	 * The other TSockAddr fields are not touched.
    1.96  	 */
    1.97  	IMPORT_C void SetAddress(const TE64Addr& aAddr);
    1.98 -	IMPORT_C TE64Addr& Address() const;	///< Accesses the address bytes
    1.99 +	IMPORT_C TE64Addr& Address() const;	//< Accesses the address bytes
   1.100  
   1.101 -	IMPORT_C TBool Match(const TEui64Addr& aAddr) const;	///< TRUE if the address bytes match the parameter's
   1.102 -	IMPORT_C TBool IsZero() const;				///< TRUE if the address bytes are all zeros
   1.103 +	IMPORT_C TBool Match(const TEui64Addr& aAddr) const;	//< TRUE if the address bytes match the parameter's
   1.104 +	IMPORT_C TBool IsZero() const;				//< TRUE if the address bytes are all zeros
   1.105  
   1.106 -	IMPORT_C static TEui64Addr& Cast(const TSockAddr& aAddr);	///< Unsafely casts a TSockAddr to TEui64Addr
   1.107 -	IMPORT_C static TEui64Addr& Cast(const TSockAddr* aAddr);	///< Unsafely casts a TSockAddr to TEui64Addr
   1.108 +	IMPORT_C static TEui64Addr& Cast(const TSockAddr& aAddr);	//< Unsafely casts a TSockAddr to TEui64Addr
   1.109 +	IMPORT_C static TEui64Addr& Cast(const TSockAddr* aAddr);	//< Unsafely casts a TSockAddr to TEui64Addr
   1.110  
   1.111   protected:
   1.112 -	IMPORT_C SE64Addr* AddrPtr() const;	///< Returns a pointer to KAfEui64 content format
   1.113 -	IMPORT_C static TUint AddrLen();	///< Returns the size of the KAfEui64 content format
   1.114 +	IMPORT_C SE64Addr* AddrPtr() const;	//< Returns a pointer to KAfEui64 content format
   1.115 +	IMPORT_C static TUint AddrLen();	//< Returns the size of the KAfEui64 content format
   1.116  };
   1.117  
   1.118  inline TEui64Addr::TEui64Addr(const TE64Addr& aAddr) : TSockAddr()