epoc32/include/comms-infras/esock_params.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) 2003-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
#ifndef ESOCK_PARAMS_H
williamr@4
    17
#define ESOCK_PARAMS_H
williamr@4
    18
williamr@4
    19
#include <e32base.h>
williamr@4
    20
#include <e32std.h>	
williamr@4
    21
williamr@4
    22
#include <comms-infras/metadata.h>
williamr@4
    23
#include <es_prot.h>
williamr@4
    24
williamr@4
    25
class TConnAPPref : public Meta::SMetaDataECom
williamr@4
    26
/**
williamr@4
    27
Connection preference to specify an access point to start. 
williamr@4
    28
williamr@4
    29
However, this preference cannot be used with RConnection::Start as a TConnPref. It
williamr@4
    30
must be part of a TConnPrefList.
williamr@4
    31
williamr@4
    32
TConnAPPref can be added to the list to chose the top level access point. For the
williamr@4
    33
KAfInet tier this type behaves in the same way as TConnSnapPref.
williamr@4
    34
williamr@4
    35
It is recommended that at most one TConnAPPref from each tier is added to the
williamr@4
    36
TConnPrefList.
williamr@4
    37
williamr@4
    38
If no TConnAPPref is specified, then the default access point for the KAfInet
williamr@4
    39
tier will be used for selection.
williamr@4
    40
williamr@4
    41
@see TConnSnapPref
williamr@4
    42
@see TConnPrefList
williamr@4
    43
@see RConnection::Start
williamr@4
    44
williamr@4
    45
@publishedAll
williamr@4
    46
@released since 9.5
williamr@4
    47
*/
williamr@4
    48
	{
williamr@4
    49
public:
williamr@4
    50
	inline static TConnAPPref* NewL();
williamr@4
    51
	inline static TConnAPPref* NewL(TUint aAP);
williamr@4
    52
		
williamr@4
    53
	enum
williamr@4
    54
	{
williamr@4
    55
		EUid = 0x10285E27,
williamr@4
    56
		ETypeId = 2
williamr@4
    57
	};
williamr@4
    58
williamr@4
    59
	inline void SetAP(TUint aAP);
williamr@4
    60
	inline TInt GetAP();
williamr@4
    61
	
williamr@4
    62
protected:
williamr@4
    63
	DATA_VTABLE
williamr@4
    64
	
williamr@4
    65
	TUint iAP;
williamr@4
    66
	};
williamr@4
    67
williamr@4
    68
williamr@4
    69
class TConnAutoStartPref : public Meta::SMetaDataECom
williamr@4
    70
/** The connection preference requires that the connection waits until its selected access point is available
williamr@4
    71
before starting. The start request does not complete until the connection is fully up.
williamr@4
    72
williamr@4
    73
Without this preference(e.g in the TConnPrefList), if the selected access point is unavailable due to contention or
williamr@4
    74
lack of coverage, the RConnection::Start is errored immediately.
williamr@4
    75
williamr@4
    76
TConnAutoStartPref does not aid access point selection. When specified without any other preference in the
williamr@4
    77
TConnPrefList, the default access point in the KAfInet tier will be selected.
williamr@4
    78
williamr@4
    79
@code
williamr@4
    80
RConnection conn;
williamr@4
    81
User::LeaveIfError(conn.Open(sockSvr));
williamr@4
    82
CleanupClosePushL(conn);
williamr@4
    83
williamr@4
    84
TConnPrefList* prefs = TConnPrefList::NewL();
williamr@4
    85
CleanupStack::PushL(prefs);
williamr@4
    86
TConnAPPref* APPref = TConnAPPref::NewL(aPara->iAp);
williamr@4
    87
CleanupStack::PushL(APPref);
williamr@4
    88
TConnAutoStartPref autoPref = TConnAutoStartPref::NewL();
williamr@4
    89
CleanupStack::PushL(autoPref);
williamr@4
    90
williamr@4
    91
prefs->AppendL(autoPref);
williamr@4
    92
prefs->AppendL(APPref);
williamr@4
    93
williamr@4
    94
error = conn.Start(pref);
williamr@4
    95
@endcode
williamr@4
    96
williamr@4
    97
@see RConnection::Start
williamr@4
    98
@see TConnPrefList
williamr@4
    99
williamr@4
   100
@publishedAll
williamr@4
   101
@released since 9.5
williamr@4
   102
*/
williamr@4
   103
	{
williamr@4
   104
public:
williamr@4
   105
	inline static TConnAutoStartPref* NewL();
williamr@4
   106
	enum
williamr@4
   107
	{
williamr@4
   108
		EUid = 0x10285E27,
williamr@4
   109
		ETypeId = 3
williamr@4
   110
	};
williamr@4
   111
williamr@4
   112
protected:
williamr@4
   113
	DATA_VTABLE
williamr@4
   114
	};
williamr@4
   115
williamr@4
   116
williamr@4
   117
#include <comms-infras/esock_params.inl>
williamr@4
   118
williamr@4
   119
class CESockParamaterFactory : public CBase
williamr@4
   120
/** Connection generic parameter set factory.
williamr@4
   121
williamr@4
   122
@internalComponent
williamr@4
   123
*/
williamr@4
   124
	{
williamr@4
   125
public:
williamr@4
   126
	static Meta::SMetaDataECom* NewL(TAny* aConstructionParameters);
williamr@4
   127
	};
williamr@4
   128
williamr@4
   129
#endif
williamr@4
   130