datacommsserver/esockserver/inc/ss_protocolparameterset.h
changeset 0 dfb7c4ff071f
equal deleted inserted replaced
-1:000000000000 0:dfb7c4ff071f
       
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Parameter set base class for applying subconnection protocol attributes
       
    15 // 
       
    16 //
       
    17 
       
    18 /**
       
    19  @file 
       
    20  @internalComponent
       
    21 */
       
    22 
       
    23 #ifndef __SS_PROTOCOLPARAMETERSET_H__
       
    24 #define __SS_PROTOCOLPARAMETERSET_H__
       
    25 
       
    26 #include <e32base.h>
       
    27 #include <e32std.h>
       
    28 #include <comms-infras/metadata.h>
       
    29 #include <comms-infras/metatype.h>
       
    30 #include <comms-infras/metatypearray.h>
       
    31 #include <in_sock.h>
       
    32 
       
    33 #include <es_sock.h>
       
    34 #include <cs_subconparams.h>
       
    35 
       
    36 #include <comms-infras/ss_nodemessages.h>
       
    37 #include <comms-infras/ss_nodemessages_internal.h>
       
    38 
       
    39 
       
    40 namespace ESock
       
    41 {
       
    42 
       
    43 /** Conveys attributes of a flow request
       
    44 @internalTechnology
       
    45 */
       
    46 
       
    47 class CFlowRequestParameters : public CSubConGenericParameterSet
       
    48 /** Conveys attributes of a flow request
       
    49 @internalTechnology
       
    50 */
       
    51 	{
       
    52 public:
       
    53 	enum
       
    54 		{
       
    55 		EUid=KSubConnGenericParamsImplUid,
       
    56 		EType=KFlowRequestParametersType
       
    57 		};
       
    58 
       
    59 	IMPORT_C static CFlowRequestParameters* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
       
    60 	IMPORT_C static CFlowRequestParameters* NewL();
       
    61 	inline CFlowRequestParameters();
       
    62 	
       
    63 	inline void SetFlowParams(ESock::TFlowParams& aFlowParams);
       
    64 
       
    65 	inline ESock::TFlowParams& GetFlowParams();
       
    66 	inline TUid GetProtocolUid() const;
       
    67 
       
    68 protected:
       
    69 	DATA_VTABLE
       
    70 
       
    71 	ESock::TFlowParams iFlowParams;
       
    72 	};
       
    73 
       
    74 
       
    75 /**
       
    76 @internalComponent
       
    77 */
       
    78 
       
    79 /** Specifier for protocol extension factory
       
    80 @internalComponent
       
    81 */
       
    82 struct TProtocolExtensionSpecifier
       
    83 	{
       
    84 	TProtocolExtensionSpecifier(
       
    85 		TUid aTierId,
       
    86 		TUid aSCPRFactoryUid
       
    87 		)
       
    88 			: iSCPRFactoryUid(aSCPRFactoryUid), iTierId(aTierId) {}
       
    89 	
       
    90 	TProtocolExtensionSpecifier() : iSCPRFactoryUid(TUid::Null()), iTierId(TUid::Null()) {}
       
    91 
       
    92 	TUid iSCPRFactoryUid;
       
    93 	TUid iTierId;
       
    94 	};
       
    95 
       
    96 
       
    97 class CSubConnectionProtocolParameterSet : public CSubConGenericParameterSet
       
    98 /** Base class for protocol extension parameters
       
    99 
       
   100 This class is a base class for protocol extensions such as RTP
       
   101 
       
   102 @internalComponent
       
   103 */
       
   104 	{
       
   105 public:
       
   106 	enum
       
   107 		{
       
   108 		EUid=KSubConnGenericParamsImplUid,
       
   109 		EType=KSubConnProtocolGenericParamsType
       
   110 		};
       
   111 
       
   112 
       
   113 	IMPORT_C static CSubConnectionProtocolParameterSet* NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType);
       
   114 	IMPORT_C static CSubConnectionProtocolParameterSet* NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType);
       
   115 	IMPORT_C static CSubConnectionProtocolParameterSet* NewL();
       
   116 
       
   117 	IMPORT_C CSubConnectionProtocolParameterSet();
       
   118 	
       
   119 	IMPORT_C TInt FindAndRemoveExtension(TProtocolExtensionSpecifier& aExtensionSpec, const TUid& aTierId);
       
   120 
       
   121 	IMPORT_C virtual ~CSubConnectionProtocolParameterSet();
       
   122 
       
   123 protected:
       
   124 	IMPORT_C TInt AddExtension(const TProtocolExtensionSpecifier& aExtensionSpec);
       
   125 
       
   126 	EXPORT_DATA_VTABLE_AND_FN
       
   127 
       
   128 	RArray<TProtocolExtensionSpecifier> iExtensions;
       
   129 	};
       
   130 }
       
   131 
       
   132 #include <comms-infras/ss_protocolparameterset.inl>
       
   133 
       
   134 
       
   135 #endif // __SS_PROTOCOLPARAMETERSET_H__
       
   136 
       
   137