epoc32/include/comms-infras/es_sap.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) 1997-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
 @internalTechnology
williamr@4
    19
 @released
williamr@4
    20
*/
williamr@4
    21
williamr@4
    22
#if !defined(__ES_SAP_H__)
williamr@4
    23
#define __ES_SAP_H__
williamr@4
    24
williamr@4
    25
#define SYMBIAN_NETWORKING_UPS
williamr@4
    26
williamr@4
    27
#include <es_prot.h>
williamr@4
    28
#include <es_sock.h>
williamr@4
    29
#include <comms-infras/ss_subconnflow.h>
williamr@4
    30
#include <comms-infras/ss_flowbinders.h>
williamr@4
    31
#include <comms-infras/ss_nodemessages_dataclient.h>
williamr@4
    32
williamr@4
    33
namespace ESock
williamr@4
    34
{
williamr@4
    35
williamr@4
    36
class CNetworkFlow : public CSubConnectionFlowBase, protected MSessionData, protected MSessionControl,
williamr@4
    37
                        protected MFlowBinderControl
williamr@4
    38
/** Service Access Point for SAPs that have a seperate control side.
williamr@4
    39
williamr@4
    40
Provides transport services to a single protocol. Several of the calls to
williamr@4
    41
CServProviderBase have pre-conditions attached to them - for example
williamr@4
    42
a connection oriented protocol must have its local address set (either by
williamr@4
    43
a SetLocalName() or AutoBind()) before it is opened. If the socket server
williamr@4
    44
calls the CServProviderBase in such an erroneous way, the protocol should panic.
williamr@4
    45
williamr@4
    46
It also provides an interface towards subconnection providers to allow
williamr@4
    47
SAPs to work with a seperate control path.
williamr@4
    48
williamr@4
    49
@internalTechnology
williamr@4
    50
@released Since 9.0 */
williamr@4
    51
	{
williamr@4
    52
	friend class ProtocolManager;
williamr@4
    53
williamr@4
    54
public:
williamr@4
    55
williamr@4
    56
	IMPORT_C virtual ~CNetworkFlow();
williamr@4
    57
williamr@4
    58
protected:
williamr@4
    59
	void SetLocalName(TSockAddr& anAddr);
williamr@4
    60
	TInt SetRemName(TSockAddr& anAddr);
williamr@4
    61
	TUint Write(const TDesC8& aDesc,TUint aOptions, TSockAddr* anAddr);
williamr@4
    62
	TInt Write(RMBufChain& aData, TUint aOptions, TSockAddr* anAddr);
williamr@4
    63
    void BindToL(const TCFDataClient::TBindTo& aBindTo);
williamr@4
    64
    NetInterfaces::TInterfaceControl* FetchInterfaceControlL(TSupportedCommsApiExt aInterfaceId);
williamr@4
    65
williamr@4
    66
protected:
williamr@4
    67
williamr@4
    68
	virtual MFlowBinderControl* DoGetBinderControlL();
williamr@4
    69
	//MFlowBinderControl
williamr@4
    70
	virtual MSessionControl* GetControlL(TInt aSessionType,MSessionControlNotify& aSessionControlNotify);
williamr@4
    71
	virtual void Unbind();
williamr@4
    72
	virtual MSessionData* BindL(MSessionDataNotify& aNotify);
williamr@4
    73
	virtual CSubConnectionFlowBase* Flow(); //returns its own flow
williamr@4
    74
williamr@4
    75
    TBool IsBoundToSession() const
williamr@4
    76
        {
williamr@4
    77
        return  iSessionControlNotify || iSessionDataNotify;
williamr@4
    78
        }
williamr@4
    79
williamr@4
    80
	void ProcessDCIdleState();
williamr@4
    81
williamr@4
    82
	
williamr@4
    83
protected:
williamr@4
    84
	IMPORT_C CNetworkFlow(CSubConnectionFlowFactoryBase& aFactory, const Messages::TNodeId& aSubConn, CProtocolIntfBase* aProtocolIntf);
williamr@4
    85
	void UpdateDestinationAddress(const TSockAddr& aDest);
williamr@4
    86
williamr@4
    87
    #define SAP_FLAG_FUNCTIONS(name, flag) \
williamr@4
    88
		inline TBool name() { return iStateFlags & flag; } \
williamr@4
    89
		inline void Set##name() { iStateFlags |= flag; }	\
williamr@4
    90
		inline void Clear##name() { iStateFlags &= ~flag; }
williamr@4
    91
williamr@4
    92
#ifdef SYMBIAN_NETWORKING_UPS
williamr@4
    93
	virtual TBool ActivityRunning() = 0;
williamr@4
    94
#endif
williamr@4
    95
williamr@4
    96
williamr@4
    97
protected:
williamr@4
    98
	TSockAddr iLocalAddress;
williamr@4
    99
	TSockAddr iRemoteAddress;
williamr@4
   100
williamr@4
   101
	//upper flow
williamr@4
   102
	MSessionControlNotify* iSessionControlNotify;
williamr@4
   103
	MSessionDataNotify* iSessionDataNotify;
williamr@4
   104
	//lower flow
williamr@4
   105
	MFlowBinderControl* iLowerFlow;
williamr@4
   106
	MLowerControl* iLowerControl; //just to keep the lower flow up
williamr@4
   107
williamr@4
   108
	enum TStateFlag
williamr@4
   109
		{
williamr@4
   110
		ELocalAddressSet = 0x00000001,
williamr@4
   111
		ERemoteAddressSet = 0x00000002,
williamr@4
   112
		ENoBearerRunning = 0x00000004,
williamr@4
   113
		EStarted = 0x00000008,
williamr@4
   114
		EIdle = 0x00000080,
williamr@4
   115
		EIdleSent = 0x00000100
williamr@4
   116
		};
williamr@4
   117
	SAP_FLAG_FUNCTIONS(LocalAddressSet, ELocalAddressSet)
williamr@4
   118
	SAP_FLAG_FUNCTIONS(RemoteAddressSet, ERemoteAddressSet)
williamr@4
   119
	SAP_FLAG_FUNCTIONS(NoBearerGuard, ENoBearerRunning)
williamr@4
   120
	SAP_FLAG_FUNCTIONS(Started, EStarted)
williamr@4
   121
	SAP_FLAG_FUNCTIONS(Idle, EIdle)
williamr@4
   122
	SAP_FLAG_FUNCTIONS(IdleSent, EIdleSent)
williamr@4
   123
		
williamr@4
   124
	TUint iStateFlags;
williamr@4
   125
	};
williamr@4
   126
williamr@4
   127
} //namespace ESock
williamr@4
   128
williamr@4
   129
#endif	// __ES_SAP_H__
williamr@4
   130
williamr@4
   131