baseconnectionproviders/refscpr/inc/ReferenceSCPR_defaultSubconnProv.h
author hgs
Mon, 06 Sep 2010 13:49:23 +0100
changeset 72 ae47d0499bee
parent 50 afebdb533a85
permissions -rw-r--r--
201033_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50
afebdb533a85 201025_01
hgs
parents:
diff changeset
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
afebdb533a85 201025_01
hgs
parents:
diff changeset
     2
// All rights reserved.
afebdb533a85 201025_01
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
afebdb533a85 201025_01
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
afebdb533a85 201025_01
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
afebdb533a85 201025_01
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
afebdb533a85 201025_01
hgs
parents:
diff changeset
     7
//
afebdb533a85 201025_01
hgs
parents:
diff changeset
     8
// Initial Contributors:
afebdb533a85 201025_01
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
afebdb533a85 201025_01
hgs
parents:
diff changeset
    10
//
afebdb533a85 201025_01
hgs
parents:
diff changeset
    11
// Contributors:
afebdb533a85 201025_01
hgs
parents:
diff changeset
    12
//
afebdb533a85 201025_01
hgs
parents:
diff changeset
    13
// Description:
afebdb533a85 201025_01
hgs
parents:
diff changeset
    14
// Reference Default SubConnection Provider class definition.
afebdb533a85 201025_01
hgs
parents:
diff changeset
    15
// 
afebdb533a85 201025_01
hgs
parents:
diff changeset
    16
//
afebdb533a85 201025_01
hgs
parents:
diff changeset
    17
afebdb533a85 201025_01
hgs
parents:
diff changeset
    18
/**
afebdb533a85 201025_01
hgs
parents:
diff changeset
    19
 @file
afebdb533a85 201025_01
hgs
parents:
diff changeset
    20
 @internalComponent
afebdb533a85 201025_01
hgs
parents:
diff changeset
    21
*/
afebdb533a85 201025_01
hgs
parents:
diff changeset
    22
afebdb533a85 201025_01
hgs
parents:
diff changeset
    23
afebdb533a85 201025_01
hgs
parents:
diff changeset
    24
#if !defined(__REFERENCESCPR_DEFAULTSUBCONNPROV_H__)
afebdb533a85 201025_01
hgs
parents:
diff changeset
    25
#define __REFERENCESCPR_DEFAULTSUBCONNPROV_H__
afebdb533a85 201025_01
hgs
parents:
diff changeset
    26
afebdb533a85 201025_01
hgs
parents:
diff changeset
    27
afebdb533a85 201025_01
hgs
parents:
diff changeset
    28
#include "ReferenceSCPR_subconnProv.h"
afebdb533a85 201025_01
hgs
parents:
diff changeset
    29
afebdb533a85 201025_01
hgs
parents:
diff changeset
    30
afebdb533a85 201025_01
hgs
parents:
diff changeset
    31
class CReferenceDefaultSubConnectionProvider : public CSubConnectionProviderBase, public MConnectionDataClient
afebdb533a85 201025_01
hgs
parents:
diff changeset
    32
/** 
afebdb533a85 201025_01
hgs
parents:
diff changeset
    33
CReferenceDefaultSubConnectionProvider is a reference implementation for a shared subconnection,
afebdb533a85 201025_01
hgs
parents:
diff changeset
    34
that is: either 
afebdb533a85 201025_01
hgs
parents:
diff changeset
    35
* a subconnection explicitly requested by a client openning an RSubConnection in EAttachToDefault mode
afebdb533a85 201025_01
hgs
parents:
diff changeset
    36
* an implicitly created shared subconnection.
afebdb533a85 201025_01
hgs
parents:
diff changeset
    37
Typically reserved and shared subconnection providers, although represent the
afebdb533a85 201025_01
hgs
parents:
diff changeset
    38
same layer/technology, require different implementations of CSubConnectionProviderBase. 
afebdb533a85 201025_01
hgs
parents:
diff changeset
    39
This example code takes that into account and provides two separate classes for reserved and 
afebdb533a85 201025_01
hgs
parents:
diff changeset
    40
shared subconnections respectivelly. Should the implementation differ little or not differ at all,
afebdb533a85 201025_01
hgs
parents:
diff changeset
    41
developers are encouraged to introduce inheritance between the two types or implement just one
afebdb533a85 201025_01
hgs
parents:
diff changeset
    42
universal CSubConnectionProviderBase subclass, if sensible.
afebdb533a85 201025_01
hgs
parents:
diff changeset
    43
The following should be read like a class diagram for a CSubConnectionProviderBase:
afebdb533a85 201025_01
hgs
parents:
diff changeset
    44
===================================================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    45
afebdb533a85 201025_01
hgs
parents:
diff changeset
    46
                            [MSubConnectionControlClient]
afebdb533a85 201025_01
hgs
parents:
diff changeset
    47
LAYER N-1                               ^
afebdb533a85 201025_01
hgs
parents:
diff changeset
    48
                                        |
afebdb533a85 201025_01
hgs
parents:
diff changeset
    49
    [MSubConnectionDataClient]<-n-      n         [MSubConnectionDataClient]<-n-
afebdb533a85 201025_01
hgs
parents:
diff changeset
    50
                                  |     |              /\                       |
afebdb533a85 201025_01
hgs
parents:
diff changeset
    51
LAYER N                           1     1             is a                      1
afebdb533a85 201025_01
hgs
parents:
diff changeset
    52
                                  |     |              ||                       |
afebdb533a85 201025_01
hgs
parents:
diff changeset
    53
    [ServiceAccessPoint]<-n--1-[CSubConnectionProviderBase]-1-----n->[CConnectionProviderBase]
afebdb533a85 201025_01
hgs
parents:
diff changeset
    54
                                        |
afebdb533a85 201025_01
hgs
parents:
diff changeset
    55
                                        n
afebdb533a85 201025_01
hgs
parents:
diff changeset
    56
                                        |
afebdb533a85 201025_01
hgs
parents:
diff changeset
    57
                                        1
afebdb533a85 201025_01
hgs
parents:
diff changeset
    58
LAYER N+1                               v
afebdb533a85 201025_01
hgs
parents:
diff changeset
    59
                                     [CSubConnectionProviderBase]
afebdb533a85 201025_01
hgs
parents:
diff changeset
    60
====================================================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    61
@internalComponent
afebdb533a85 201025_01
hgs
parents:
diff changeset
    62
@released since v9.2
afebdb533a85 201025_01
hgs
parents:
diff changeset
    63
*/
afebdb533a85 201025_01
hgs
parents:
diff changeset
    64
	{
afebdb533a85 201025_01
hgs
parents:
diff changeset
    65
public:	    
afebdb533a85 201025_01
hgs
parents:
diff changeset
    66
afebdb533a85 201025_01
hgs
parents:
diff changeset
    67
	//-=========================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    68
	// MConnectionDataClient methods
afebdb533a85 201025_01
hgs
parents:
diff changeset
    69
	//-=========================================================	
afebdb533a85 201025_01
hgs
parents:
diff changeset
    70
	virtual void Notify(TNotify aNotifyType, CConnectionProviderBase* aConnProvider, TInt aError, const CConNotificationEvent* aConNotificationEvent);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    71
  	virtual void AttachToNext(CSubConnectionProviderBase* aSubConnProvider);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    72
	virtual void ConnectionGoingDown(CConnectionProviderBase& aConnProvider);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    73
	virtual void ConnectionError(TInt aStage, TInt aError);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    74
afebdb533a85 201025_01
hgs
parents:
diff changeset
    75
afebdb533a85 201025_01
hgs
parents:
diff changeset
    76
afebdb533a85 201025_01
hgs
parents:
diff changeset
    77
	//-=========================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    78
	// CSubConnectionProviderBase methods
afebdb533a85 201025_01
hgs
parents:
diff changeset
    79
	//-=========================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    80
	virtual void DoDataClientJoiningL(MSubConnectionDataClient& aDataClient);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    81
	virtual void DoDataClientLeaving(MSubConnectionDataClient& aDataClient);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    82
	virtual void DoControlClientJoiningL(MSubConnectionControlClient& aControlClient);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    83
	virtual void DoControlClientLeaving(MSubConnectionControlClient& aControlClient);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    84
	virtual void DoSourceAddressUpdate(MSubConnectionDataClient& aDataClient, const TSockAddr& aSource);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    85
	virtual void DoDestinationAddressUpdate(MSubConnectionDataClient& aDataClient, const TSockAddr& aDestination);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    86
	virtual void DoDataClientRouted(MSubConnectionDataClient& aDataClient, const TSockAddr& aSource, const TSockAddr& aDestination, const TDesC8& aConnectionInfo);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    87
	virtual void DoParametersAboutToBeSetL(CSubConParameterBundle& aParameterBundle);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    88
	virtual TInt DoControl(TUint aOptionLevel, TUint aOptionName, TDes8& aOption);
afebdb533a85 201025_01
hgs
parents:
diff changeset
    89
	virtual CConnDataTransfer& DoDataTransferL();
afebdb533a85 201025_01
hgs
parents:
diff changeset
    90
	virtual MConnectionDataClient* DoSelfConnectionDataClient();
afebdb533a85 201025_01
hgs
parents:
diff changeset
    91
    virtual void DoStartL();
afebdb533a85 201025_01
hgs
parents:
diff changeset
    92
	virtual void DoStop();
afebdb533a85 201025_01
hgs
parents:
diff changeset
    93
	virtual CSubConnectionProviderBase* DoNextLayer();
afebdb533a85 201025_01
hgs
parents:
diff changeset
    94
	
afebdb533a85 201025_01
hgs
parents:
diff changeset
    95
afebdb533a85 201025_01
hgs
parents:
diff changeset
    96
protected:
afebdb533a85 201025_01
hgs
parents:
diff changeset
    97
	
afebdb533a85 201025_01
hgs
parents:
diff changeset
    98
	//-=========================================================
afebdb533a85 201025_01
hgs
parents:
diff changeset
    99
	// Custom methods
afebdb533a85 201025_01
hgs
parents:
diff changeset
   100
	//-=========================================================	
afebdb533a85 201025_01
hgs
parents:
diff changeset
   101
	friend class CReferenceSubConnectionProviderFactory;	
afebdb533a85 201025_01
hgs
parents:
diff changeset
   102
afebdb533a85 201025_01
hgs
parents:
diff changeset
   103
	CReferenceDefaultSubConnectionProvider(CSubConnectionProviderFactoryBase& aFactory, 
afebdb533a85 201025_01
hgs
parents:
diff changeset
   104
	                                       CConnectionProviderBase& aConnProvider);
afebdb533a85 201025_01
hgs
parents:
diff changeset
   105
	static CReferenceDefaultSubConnectionProvider* NewL(CSubConnectionProviderFactoryBase& aFactory, 
afebdb533a85 201025_01
hgs
parents:
diff changeset
   106
	                                       CConnectionProviderBase& aConnProvider);
afebdb533a85 201025_01
hgs
parents:
diff changeset
   107
	void ConstructL();
afebdb533a85 201025_01
hgs
parents:
diff changeset
   108
	virtual ~CReferenceDefaultSubConnectionProvider();
afebdb533a85 201025_01
hgs
parents:
diff changeset
   109
	
afebdb533a85 201025_01
hgs
parents:
diff changeset
   110
public:
afebdb533a85 201025_01
hgs
parents:
diff changeset
   111
	__FLOG_DECLARATION_MEMBER;
afebdb533a85 201025_01
hgs
parents:
diff changeset
   112
	
afebdb533a85 201025_01
hgs
parents:
diff changeset
   113
	};
afebdb533a85 201025_01
hgs
parents:
diff changeset
   114
afebdb533a85 201025_01
hgs
parents:
diff changeset
   115
#endif	// __REFERENCESCPR_DEFAULTSUBCONNPROV_H__