epoc32/include/es_enum.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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@2
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@4
    16
williamr@4
    17
/**
williamr@4
    18
 @file
williamr@4
    19
 @publishedAll
williamr@4
    20
 @released
williamr@4
    21
*/
williamr@4
    22
williamr@2
    23
#if !defined (__ES_ENUM_H__)
williamr@2
    24
#define __ES_ENUM_H__
williamr@2
    25
williamr@2
    26
#include <e32std.h>
williamr@2
    27
#include <nifvar.h>
williamr@2
    28
#include <es_sock.h>
williamr@2
    29
williamr@4
    30
williamr@2
    31
class TConnArgBase
williamr@2
    32
/**
williamr@2
    33
 * Base class for many arguments to RConnection functions.  Provides versioning information.
williamr@2
    34
 * @note Not intended for user instantiation
williamr@2
    35
 * @publishedAll
williamr@2
    36
 * @released since v7.0s
williamr@2
    37
 */
williamr@2
    38
	{
williamr@2
    39
public:
williamr@2
    40
	inline TConnArgBase();
williamr@4
    41
	inline TConnArgBase(const TDesC8& aConnectionInfo)
williamr@4
    42
	:	iVersion(*((TUint8*)aConnectionInfo.Ptr()))
williamr@4
    43
		{
williamr@4
    44
		}
williamr@2
    45
	inline TUint8 Version() const;
williamr@2
    46
williamr@2
    47
protected:
williamr@2
    48
	inline TConnArgBase(TUint8 aVersion);
williamr@2
    49
williamr@2
    50
protected:
williamr@2
    51
	TUint8 iVersion;
williamr@2
    52
	TUint8 iReserved[3];
williamr@2
    53
	};
williamr@2
    54
williamr@2
    55
/**
williamr@2
    56
 * Versioning information for connection arguments
williamr@2
    57
 * @publishedAll
williamr@2
    58
 * @released since v7.0s
williamr@2
    59
 */
williamr@2
    60
const TUint8 KConnArgVersion1 = 1;
williamr@2
    61
williamr@2
    62
/**
williamr@2
    63
Versioning information for connection arguments
williamr@2
    64
williamr@2
    65
@publishedAll
williamr@2
    66
@released
williamr@2
    67
*/
williamr@2
    68
const TUint8 KConnArgVersion2 = 2;
williamr@2
    69
williamr@2
    70
class TConnectionInfo : public TConnArgBase
williamr@2
    71
/**
williamr@2
    72
@publishedAll
williamr@2
    73
@released since v7.0s
williamr@2
    74
*/
williamr@2
    75
	{
williamr@2
    76
public:
williamr@2
    77
	inline TConnectionInfo();
williamr@4
    78
	TConnectionInfo(const TDesC8& aConnectionInfo /*as passed to ::Bearer*/);
williamr@2
    79
	inline TConnectionInfo(TUint32 aIapId, TUint32 aNetId);
williamr@2
    80
williamr@2
    81
	static TBool IsLocalBearer(const TDesC8& aConnectionInfo);
williamr@4
    82
williamr@4
    83
	inline bool operator == (const TConnectionInfo& aRhs) const;
williamr@4
    84
williamr@2
    85
protected:
williamr@2
    86
	inline TConnectionInfo(TUint8 aVersion, TUint32 aIapId, TUint32 aNetId);
williamr@2
    87
williamr@2
    88
public:
williamr@2
    89
	TUint32 iIapId;
williamr@2
    90
	TUint32 iNetId;
williamr@2
    91
	};
williamr@2
    92
williamr@4
    93
const TUint8 KConnArgVersion3 = 3;
williamr@4
    94
williamr@4
    95
williamr@2
    96
/**
williamr@2
    97
@publishedAll
williamr@2
    98
@released since v7.0s
williamr@2
    99
*/
williamr@2
   100
typedef TPckgBuf<TConnectionInfo> TConnectionInfoBuf;
williamr@2
   101
williamr@2
   102
williamr@2
   103
williamr@2
   104
williamr@2
   105
/**
williamr@2
   106
The following classes are used with RConnection::AllInterfaceNotification() to receive information
williamr@2
   107
about interfaces coming up and going down.
williamr@2
   108
*/
williamr@2
   109
williamr@2
   110
/**
williamr@2
   111
@publishedAll
williamr@2
   112
@released since v7.0s
williamr@2
   113
*/
williamr@2
   114
enum TConnInterfaceState
williamr@2
   115
	{
williamr@2
   116
	EInterfaceUp,
williamr@2
   117
	EInterfaceDown
williamr@2
   118
	};
williamr@2
   119
williamr@2
   120
class TInterfaceNotification
williamr@2
   121
/**
williamr@2
   122
@publishedAll
williamr@2
   123
@released since v7.0s
williamr@2
   124
*/
williamr@2
   125
	{
williamr@2
   126
public:
williamr@2
   127
	TConnectionInfo iConnectionInfo;
williamr@2
   128
	TConnInterfaceState iState;
williamr@2
   129
	};
williamr@2
   130
williamr@2
   131
williamr@2
   132
/**
williamr@2
   133
Types of events that can occur on a subconnection
williamr@2
   134
williamr@2
   135
@publishedAll
williamr@2
   136
@released
williamr@2
   137
*/
williamr@2
   138
enum TSubConnectionEventType
williamr@2
   139
/**
williamr@2
   140
 * Types of events that can occur on a subconnection
williamr@2
   141
 * @publishedPartner
williamr@2
   142
 * @released since v7.0s
williamr@2
   143
 */
williamr@2
   144
	{
williamr@4
   145
	ESubConnectionOpened,           //< Connection values 0-9999 for agent-based events
williamr@4
   146
	ESubConnectionClosed,           //< Connection values 0-9999 for agent-based events
williamr@4
   147
	ESubConnectionQoSChanged = 1000 //< Connection values 10000-19999 for nif-based events
williamr@2
   148
	};
williamr@2
   149
williamr@4
   150
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   151
#include <es_enum_partner.h>
williamr@4
   152
#include <es_enum_internal.h>
williamr@4
   153
#endif
williamr@2
   154
williamr@2
   155
#include <es_enum.inl>
williamr@2
   156
williamr@4
   157
williamr@2
   158
#endif // __ES_ENUM_H__
williamr@4
   159