epoc32/include/comms-infras/ss_connprov.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
//
williamr@4
    15
williamr@4
    16
/**
williamr@4
    17
 @file
williamr@4
    18
 @internalComponent 
williamr@4
    19
*/
williamr@4
    20
williamr@4
    21
#if !defined(__SS_CONNPROV_H__)
williamr@4
    22
#define __SS_CONNPROV_H__
williamr@4
    23
williamr@4
    24
#include <e32def.h>
williamr@4
    25
#include <elements/metadata.h>
williamr@4
    26
#include <ss_select.h>
williamr@4
    27
#include <elements/factorynotify.h>
williamr@4
    28
#include <es_sock.h> //TNifProgressBuf & co
williamr@4
    29
#include <es_prot.h> //TConnStartType &co
williamr@4
    30
#include <comms-infras/ss_mmcommsprov.h>
williamr@4
    31
#include <comms-infras/ss_metaconnprov.h> //For TProviderInfo which may need to be moved to a different header in case of a circular dep.
williamr@4
    32
#include <comms-infras/ss_nodemessages_cpr.h>
williamr@4
    33
#include <comms-infras/ss_nodemessages_internal.h>
williamr@4
    34
williamr@4
    35
#include <comms-infras/ss_common.h>
williamr@4
    36
#include <comms-infras/ss_commsprov.h>
williamr@4
    37
#include <comms-infras/ss_fact_internal.h>
williamr@4
    38
williamr@4
    39
namespace ESock
williamr@4
    40
{
williamr@4
    41
williamr@4
    42
const TInt KConnInfoPart = 8; //TODO: delete with TConnectionInfo
williamr@4
    43
williamr@4
    44
class CConnection;
williamr@4
    45
class CCommsFactoryBase;
williamr@4
    46
class CConnectionProviderBase;
williamr@4
    47
class CSubConnectionProviderBase;
williamr@4
    48
williamr@4
    49
const TInt KProtocolAny	= 0xffffff1; //cooked-up constant for any protocol
williamr@4
    50
const TInt KConnectionFactoryInterfaceUid = 0x102070EE;
williamr@4
    51
williamr@4
    52
class XConnectionProviderInfoQuery : public Factories::MFactoryQuery
williamr@4
    53
/** Class implementing MCommsFactoryQuery to find a connection provider by
williamr@4
    54
 * using iProviderInfo
williamr@4
    55
williamr@4
    56
@internalTechnology
williamr@4
    57
*/
williamr@4
    58
	{
williamr@4
    59
public:
williamr@4
    60
	explicit XConnectionProviderInfoQuery(const TProviderInfo aProviderInfo)
williamr@4
    61
	:	iProviderInfo(aProviderInfo)
williamr@4
    62
		{
williamr@4
    63
		}
williamr@4
    64
	explicit XConnectionProviderInfoQuery(const TUint32 aAPid)
williamr@4
    65
	    :   iAPid(aAPid)
williamr@4
    66
	        {
williamr@4
    67
	        }
williamr@4
    68
williamr@4
    69
	IMPORT_C virtual TMatchResult Match(Factories::TFactoryObjectInfo& aProviderInfo);
williamr@4
    70
williamr@4
    71
	TProviderInfo iProviderInfo;
williamr@4
    72
	TUint32 iAPid;
williamr@4
    73
williamr@4
    74
protected:
williamr@4
    75
	explicit XConnectionProviderInfoQuery()
williamr@4
    76
	:	iProviderInfo(TProviderInfo::NullProviderInfo())
williamr@4
    77
		{
williamr@4
    78
		}
williamr@4
    79
	};
williamr@4
    80
williamr@4
    81
class CConnectionProviderFactoryBase;
williamr@4
    82
class CConnectionProviderBase;
williamr@4
    83
class CConnectionFactoryContainer : public CCommsFactoryContainer
williamr@4
    84
/** Container for connection provider factories.
williamr@4
    85
Note that there is a 1-1 mapping between aProtocolId and aFactoryId at the moment
williamr@4
    86
williamr@4
    87
@internalTechnology
williamr@4
    88
@released Since 9.1 */
williamr@4
    89
	{
williamr@4
    90
	friend class CConnectionProviderFactoryBase;
williamr@4
    91
#ifdef __X86GCC__
williamr@4
    92
protected:
williamr@4
    93
 	// gcc-mingw does not support declaring friends from different namespaces so we define proxy
williamr@4
    94
 	// functions to do the cast.
williamr@4
    95
    friend CConnectionProviderBase* __x86gcc_connection_provider_base_cast(Factories::AFactoryObject* aFactoryObject);
williamr@4
    96
    friend const CConnectionProviderBase* __x86gcc_connection_provider_base_cast(const Factories::AFactoryObject* aFactoryObject);
williamr@4
    97
williamr@4
    98
    enum
williamr@4
    99
        {
williamr@4
   100
        EId = EConnectionFactoryContainer
williamr@4
   101
        };
williamr@4
   102
#elif defined(__GCCXML__)
williamr@4
   103
public:
williamr@4
   104
    enum
williamr@4
   105
        {
williamr@4
   106
        EId = EConnectionFactoryContainer
williamr@4
   107
        };
williamr@4
   108
#else
williamr@4
   109
protected:
williamr@4
   110
    friend CConnectionProviderBase* Factories::factoryobject_cast<CConnectionProviderBase>(Factories::AFactoryObject* aFactoryObject);
williamr@4
   111
    friend const CConnectionProviderBase* Factories::factoryobject_cast<const CConnectionProviderBase>(const Factories::AFactoryObject* aFactoryObject);
williamr@4
   112
williamr@4
   113
    enum
williamr@4
   114
        {
williamr@4
   115
        EId = EConnectionFactoryContainer
williamr@4
   116
        };
williamr@4
   117
#endif
williamr@4
   118
williamr@4
   119
public:
williamr@4
   120
	IMPORT_C static CConnectionFactoryContainer* NewL();
williamr@4
   121
williamr@4
   122
	CConnectionProviderFactoryBase* Factory( TInt aIndex ) const;
williamr@4
   123
    IMPORT_C static CConnectionFactoryContainer& Singleton();
williamr@4
   124
	virtual ~CConnectionFactoryContainer();
williamr@4
   125
williamr@4
   126
protected:
williamr@4
   127
	CConnectionFactoryContainer();
williamr@4
   128
	virtual void ReceivedL(const Messages::TRuntimeCtxId& aSender, const Messages::TNodeId& aRecipient, Messages::TSignatureBase& aMessage);
williamr@4
   129
	};
williamr@4
   130
williamr@4
   131
class CConnectionProviderBase;
williamr@4
   132
class CConnectionProviderFactoryBase : public CCommsFactoryBase
williamr@4
   133
/** Base class for all connection provider factories. Specifies the interface
williamr@4
   134
    that all connection provider factories must implement. It also providers the
williamr@4
   135
	ECOM framework (via CCommsFactoryBase) to load connection provider factories
williamr@4
   136
	from other Dynamic Linked Libraries.
williamr@4
   137
williamr@4
   138
@internalTechnology
williamr@4
   139
@released Since 9.1 */
williamr@4
   140
	{
williamr@4
   141
	friend class CConnectionProviderBase;
williamr@4
   142
public:
williamr@4
   143
	IMPORT_C static CConnectionProviderFactoryBase* NewL(const TDesC8& aName, CConnectionFactoryContainer& aParentContainer);
williamr@4
   144
	IMPORT_C virtual ~CConnectionProviderFactoryBase();
williamr@4
   145
williamr@4
   146
	IMPORT_C ACommsFactoryNodeId* CreateL(TFactoryQueryBase& aQuery); //sync
williamr@4
   147
williamr@4
   148
protected:
williamr@4
   149
	IMPORT_C CConnectionProviderFactoryBase(TUid aFactoryId, CConnectionFactoryContainer& aParentContainer);
williamr@4
   150
williamr@4
   151
	IMPORT_C ACommsFactoryNodeId* DoFindOrCreateObjectL(TFactoryQueryBase& aQuery);
williamr@4
   152
	/** Override this to create a new instance of CConnectionProviderBase
williamr@4
   153
williamr@4
   154
	@return Pointer to the newly created provider
williamr@4
   155
	@exception Leaves in out of memory conditions */
williamr@4
   156
	IMPORT_C virtual ACommsFactoryNodeId* DoCreateObjectL(TFactoryQueryBase& aQuery);
williamr@4
   157
williamr@4
   158
protected:
williamr@4
   159
	struct TInternalData
williamr@4
   160
		{
williamr@4
   161
		};
williamr@4
   162
williamr@4
   163
protected:
williamr@4
   164
	TInternalData* iInternalData;
williamr@4
   165
	};
williamr@4
   166
williamr@4
   167
//
williamr@4
   168
// CConnectionProviderBase
williamr@4
   169
class CConnectionSettings;
williamr@4
   170
class CConnectionProviderBase : public CMMCommsProviderBase, public TCFCpr
williamr@4
   171
/**	Base class specifying the interfaces required to implement a connection provider.
williamr@4
   172
	Contains collections of control and data clients and defines operations on them
williamr@4
   173
williamr@4
   174
@internalTechnology
williamr@4
   175
@released Since 9.1 */
williamr@4
   176
	{
williamr@4
   177
	friend class CConnectionProviderFactoryBase;
williamr@4
   178
#ifdef __X86GCC__
williamr@4
   179
 	// gcc-mingw does not support declaring friends from different namespaces so we define proxy
williamr@4
   180
 	// functions to do the cast.
williamr@4
   181
    friend  CConnectionProviderBase* __x86gcc_connection_provider_base_cast(Messages::ANode* aNode);
williamr@4
   182
    friend  CConnectionProviderBase& __x86gcc_connection_provider_base_cast(Messages::ANode& aNode);
williamr@4
   183
#elif !defined(__GCCXML__)
williamr@4
   184
    friend  CConnectionProviderBase* mcfnode_cast<CConnectionProviderBase>(Messages::ANode* aNode);
williamr@4
   185
    friend  CConnectionProviderBase& mcfnode_cast<CConnectionProviderBase>(Messages::ANode& aNode);
williamr@4
   186
#endif
williamr@4
   187
williamr@4
   188
public:
williamr@4
   189
	inline const TProviderInfo& ProviderInfo() const
williamr@4
   190
		{
williamr@4
   191
		const TProviderInfoExt* providerInfo = static_cast<const TProviderInfoExt*>(AccessPointConfig().FindExtension(
williamr@4
   192
				STypeId::CreateSTypeId(TProviderInfoExt::EUid, TProviderInfoExt::ETypeId)));
williamr@4
   193
		ASSERT(providerInfo);
williamr@4
   194
		return providerInfo->iProviderInfo;
williamr@4
   195
		}
williamr@4
   196
williamr@4
   197
    Messages::RNodeInterface* DefaultSubConnectionProvider() const
williamr@4
   198
        {
williamr@4
   199
        return MeshMachine::AMMNodeBase::GetFirstClient<Messages::TDefaultClientMatchPolicy>(Messages::TClientType(TCFClientType::EData,TCFClientType::EDefault));
williamr@4
   200
        }
williamr@4
   201
williamr@4
   202
protected:
williamr@4
   203
	IMPORT_C CConnectionProviderBase(CConnectionProviderFactoryBase& aFactory,
williamr@4
   204
	                                 const MeshMachine::TNodeActivityMap& aActivityMap);
williamr@4
   205
	IMPORT_C virtual Messages::RNodeInterface* NewClientInterfaceL(const Messages::TClientType& aClientType, TAny* aClientInfo = NULL);
williamr@4
   206
	IMPORT_C ~CConnectionProviderBase();
williamr@4
   207
	};
williamr@4
   208
williamr@4
   209
#ifdef __X86GCC__
williamr@4
   210
 	// gcc-mingw does not support declaring friends from different namespaces so we define proxy
williamr@4
   211
 	// functions to do the cast...
williamr@4
   212
williamr@4
   213
	inline CConnectionProviderBase* __x86gcc_connection_provider_base_cast(Messages::ANode* aNode)
williamr@4
   214
    	{
williamr@4
   215
    	return static_cast<CConnectionProviderBase*>(aNode);
williamr@4
   216
    	}
williamr@4
   217
williamr@4
   218
	inline CConnectionProviderBase& __x86gcc_connection_provider_base_cast(Messages::ANode& aNode)
williamr@4
   219
    	{
williamr@4
   220
    	return static_cast<CConnectionProviderBase&>(aNode);
williamr@4
   221
    	}
williamr@4
   222
williamr@4
   223
	inline CConnectionProviderBase* __x86gcc_connection_provider_base_cast(Factories::AFactoryObject* aFactoryObject)
williamr@4
   224
    	{
williamr@4
   225
	    return ESock::CConnectionFactoryContainer::EId == static_cast<ESock::CCommsFactoryContainer&>(aFactoryObject->Factory().ParentContainer()).iId?
williamr@4
   226
	    	static_cast<ESock::CConnectionProviderBase*>(aFactoryObject) : NULL;
williamr@4
   227
    	}
williamr@4
   228
williamr@4
   229
	inline const CConnectionProviderBase* __x86gcc_connection_provider_base_cast(const Factories::AFactoryObject* aFactoryObject)
williamr@4
   230
    	{
williamr@4
   231
	    return ESock::CConnectionFactoryContainer::EId == static_cast<ESock::CCommsFactoryContainer&>(aFactoryObject->Factory().ParentContainer()).iId?
williamr@4
   232
	    	static_cast<const ESock::CConnectionProviderBase*>(aFactoryObject) : NULL;
williamr@4
   233
    	}
williamr@4
   234
#endif
williamr@4
   235
}//namespace ESock
williamr@4
   236
williamr@4
   237
williamr@4
   238
#ifdef __X86GCC__
williamr@4
   239
	namespace Messages
williamr@4
   240
	{
williamr@4
   241
 	// gcc-mingw does not support declaring friends from different namespaces so we define proxy
williamr@4
   242
 	// functions to do the cast.
williamr@4
   243
	template <>
williamr@4
   244
	inline ESock::CConnectionProviderBase* mnode_cast<ESock::CConnectionProviderBase>(Messages::ANode* aNode)
williamr@4
   245
		{
williamr@4
   246
		return ESock::__x86gcc_connection_provider_base_cast(aNode);
williamr@4
   247
		}
williamr@4
   248
williamr@4
   249
	template <>
williamr@4
   250
	inline ESock::CConnectionProviderBase& mnode_cast<ESock::CConnectionProviderBase>(Messages::ANode& aNode)
williamr@4
   251
		{
williamr@4
   252
		return ESock::__x86gcc_connection_provider_base_cast(aNode);
williamr@4
   253
		}
williamr@4
   254
	}
williamr@4
   255
#endif
williamr@4
   256
williamr@4
   257
williamr@4
   258
namespace Factories
williamr@4
   259
{
williamr@4
   260
williamr@4
   261
#ifdef __X86GCC__
williamr@4
   262
 	// gcc-mingw does not support declaring friends from different namespaces so we define proxy
williamr@4
   263
 	// functions to do the cast.
williamr@4
   264
	template<>
williamr@4
   265
	inline ESock::CConnectionProviderBase* factoryobject_cast<ESock::CConnectionProviderBase>(Factories::AFactoryObject* aFactoryObject)
williamr@4
   266
	    {
williamr@4
   267
		return ESock::__x86gcc_connection_provider_base_cast(aFactoryObject);
williamr@4
   268
	    }
williamr@4
   269
williamr@4
   270
	template<>
williamr@4
   271
	inline const ESock::CConnectionProviderBase* factoryobject_cast<const ESock::CConnectionProviderBase>(const Factories::AFactoryObject* aFactoryObject)
williamr@4
   272
	    {
williamr@4
   273
		return ESock::__x86gcc_connection_provider_base_cast(aFactoryObject);
williamr@4
   274
	    }
williamr@4
   275
#else
williamr@4
   276
	// RVCT does not allow the specialisation of template functions in a different namespace from the original
williamr@4
   277
	// so we declare them in the Factories namespace.
williamr@4
   278
	template<>
williamr@4
   279
	inline ESock::CConnectionProviderBase* factoryobject_cast<ESock::CConnectionProviderBase>(Factories::AFactoryObject* aFactoryObject)
williamr@4
   280
	    {
williamr@4
   281
	    return ESock::CConnectionFactoryContainer::EId == static_cast<ESock::CCommsFactoryContainer&>(aFactoryObject->Factory().ParentContainer()).iId?
williamr@4
   282
	    	static_cast<ESock::CConnectionProviderBase*>(aFactoryObject) : NULL;
williamr@4
   283
	    }
williamr@4
   284
williamr@4
   285
	template<>
williamr@4
   286
	inline const ESock::CConnectionProviderBase* factoryobject_cast<const ESock::CConnectionProviderBase>(const Factories::AFactoryObject* aFactoryObject)
williamr@4
   287
	    {
williamr@4
   288
	    return ESock::CConnectionFactoryContainer::EId == static_cast<ESock::CCommsFactoryContainer&>(aFactoryObject->Factory().ParentContainer()).iId?
williamr@4
   289
	    	static_cast<const ESock::CConnectionProviderBase*>(aFactoryObject) : NULL;
williamr@4
   290
	    }
williamr@4
   291
#endif
williamr@4
   292
williamr@4
   293
}//namespace Factories
williamr@4
   294
williamr@4
   295
#endif	// __SS_CONNPROV_H__
williamr@4
   296
williamr@4
   297
williamr@4
   298