epoc32/include/remconaddress.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
--- a/epoc32/include/remconaddress.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/remconaddress.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,99 @@
-remconaddress.h
+// Copyright (c) 2004-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
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+
+
+/**
+ @file
+ @publishedAll
+ @released
+*/
+
+#ifndef REMCONADDRESS_H
+#define REMCONADDRESS_H
+
+#include <e32base.h>
+
+/**
+Represents a single remote device address in terms of the bearer used to 
+connect to the device and some bearer-specific connection information.
+*/
+class TRemConAddress
+	{
+public:
+	/** This is maximum supported size for a bearer-specific remote device 
+	address (cf. TSockAddr). */
+	static const TUint KMaxAddrSize = 0x1c;
+
+	/** Link between elements of this type in a TSglQue. */
+	TSglQueLink iLink;
+
+public:
+	/** Constructor. */
+	IMPORT_C TRemConAddress();
+
+	/** Destructor. */
+	IMPORT_C ~TRemConAddress();
+
+public:
+	/**
+	The address is null if the bearer UID is the null UID.
+	@return ETrue if the address is invalid/null, EFalse otherwise.
+	*/
+	IMPORT_C TBool IsNull() const;
+
+	/**
+	@return The bearer UID. Set this to null to make the address
+	null.
+	*/
+	IMPORT_C TUid& BearerUid();
+
+	/**
+	@return The bearer UID.
+	*/
+	IMPORT_C TUid BearerUid() const;
+
+	/**
+	@return The bearer-specific address information.
+	*/
+	IMPORT_C TBuf8<KMaxAddrSize>& Addr();
+
+	/**
+	@return The bearer-specific address information.
+	*/
+	IMPORT_C const TBuf8<KMaxAddrSize>& Addr() const;
+
+	/**
+	Equality operator.
+	@param An address to compare with.
+	@return ETrue if both bearer UIDs and sets of bearer-specific information 
+	match, EFalse otherwise.
+	*/
+	IMPORT_C TBool operator==(const TRemConAddress& aRhs) const;
+
+private:
+	/** Implementation UID of bearer (ECOM) plugin. */
+	TUid iBearerUid;
+
+	/** Buffer for bearer-specific connection address information. */
+	TBuf8<KMaxAddrSize> iAddr;
+
+	/** 
+	Pad for BC-friendly future change.
+	*/
+	TUint32 iPad;
+	};
+
+#endif // REMCONADDRESS_H