epoc32/include/cs_subconevents.inl
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) 2004-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@2
    16
/**
williamr@2
    17
 @file
williamr@2
    18
 @publishedAll
williamr@4
    19
 @released
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
#ifndef __CS_SUBCONEVENTS_INL__
williamr@2
    23
#define __CS_SUBCONEVENTS_INL__
williamr@2
    24
williamr@2
    25
williamr@2
    26
CSubConGenEventParamsGranted* CSubConGenEventParamsGranted::NewL()
williamr@2
    27
/** Creates a granted parameter event sub-connection.
williamr@2
    28
williamr@2
    29
@return a CSubConGenEventParamsGranted object pointer if successful,
williamr@2
    30
 otherwise leaves with system error code.
williamr@2
    31
*/
williamr@2
    32
	{
williamr@4
    33
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventParamsGranted);
williamr@2
    34
	return static_cast<CSubConGenEventParamsGranted*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
    35
	}
williamr@2
    36
williamr@2
    37
CSubConGenEventParamsGranted::CSubConGenEventParamsGranted()
williamr@2
    38
	: CSubConNotificationEvent(), iFamily(KSubConGlobalFamily), iGenericSet(NULL)
williamr@2
    39
/** Empty CSubConGenEventParamsGranted constructor
williamr@2
    40
*/
williamr@2
    41
	{
williamr@2
    42
	}
williamr@2
    43
williamr@2
    44
const CSubConGenericParameterSet* const CSubConGenEventParamsGranted::GetGenericSet() const
williamr@2
    45
/** Gets Generic Parameter set.
williamr@2
    46
williamr@2
    47
@return pointer to CSubConGenericParameterSet. */
williamr@2
    48
	{
williamr@2
    49
	return iGenericSet;
williamr@2
    50
	}
williamr@2
    51
williamr@2
    52
void CSubConGenEventParamsGranted::SetGenericSet(CSubConGenericParameterSet* aGenericSet)
williamr@2
    53
/** Sets Generic Parameter set.
williamr@2
    54
williamr@2
    55
@param aGenericSet pointer to Generic Parameter set. */
williamr@2
    56
	{
williamr@2
    57
	if (iGenericSet != NULL)
williamr@2
    58
		{
williamr@2
    59
		delete iGenericSet;
williamr@2
    60
		}
williamr@2
    61
	iGenericSet = aGenericSet;
williamr@2
    62
	}
williamr@2
    63
williamr@2
    64
const CSubConExtensionParameterSet* const CSubConGenEventParamsGranted::GetExtensionSet(TUint aIndex) const
williamr@2
    65
/** Gets Extension Parameter set.
williamr@2
    66
williamr@2
    67
@param aIndex the index number of the extension parameter to be returned (index number must not be greater
williamr@2
    68
			than the value returned by CSubConGenEventParamsGranted::GetNumExtensionSets())
williamr@2
    69
williamr@2
    70
@return pointer to selected CSubConExtensionParameterSet. */
williamr@2
    71
	{
williamr@2
    72
	return static_cast<CSubConExtensionParameterSet*>(iExtensionSets[aIndex]);
williamr@2
    73
	}
williamr@2
    74
williamr@2
    75
void CSubConGenEventParamsGranted::AddExtensionSetL(CSubConExtensionParameterSet* aExtensionSet)
williamr@2
    76
/** Adds Extension Parameter set.
williamr@2
    77
williamr@2
    78
@param aExtensionSet extension parameter set to be added in the list. */
williamr@2
    79
	{
williamr@2
    80
	iExtensionSets.AppendL(aExtensionSet);
williamr@2
    81
	}
williamr@2
    82
williamr@2
    83
TInt CSubConGenEventParamsGranted::GetNumExtensionSets()
williamr@2
    84
/** Gets the number of Extension Parameter set.
williamr@2
    85
williamr@2
    86
@return number of Extension Parameter set. */
williamr@2
    87
	{
williamr@2
    88
	return iExtensionSets.Count();
williamr@2
    89
	}
williamr@2
    90
williamr@2
    91
TUint32 CSubConGenEventParamsGranted::GetFamily() const
williamr@2
    92
/** Gets parameter family type.
williamr@2
    93
williamr@2
    94
@return parameter family type. */
williamr@2
    95
	{
williamr@2
    96
	return iFamily;
williamr@2
    97
	}
williamr@2
    98
williamr@2
    99
void CSubConGenEventParamsGranted::SetFamily(TUint32 aFamily)
williamr@2
   100
/** Sets parameter family type.
williamr@2
   101
williamr@2
   102
@param aFamily parameter family type. */
williamr@2
   103
	{
williamr@2
   104
	iFamily = aFamily;
williamr@2
   105
	}
williamr@2
   106
williamr@2
   107
//====================================
williamr@2
   108
williamr@2
   109
CSubConGenEventParamsChanged* CSubConGenEventParamsChanged::NewL()
williamr@2
   110
/** Creates a changed parameter event sub-connection.
williamr@2
   111
williamr@2
   112
@return CSubConGenEventParamsChanged pointer if successful,
williamr@2
   113
 otherwise leaves with system error code.
williamr@2
   114
*/
williamr@2
   115
	{
williamr@4
   116
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventParamsChanged);
williamr@2
   117
	return static_cast<CSubConGenEventParamsChanged*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
   118
	}
williamr@2
   119
williamr@2
   120
CSubConGenEventParamsChanged::CSubConGenEventParamsChanged()
williamr@2
   121
	: CSubConGenEventParamsGranted()
williamr@2
   122
/** Empty CSubConGenEventParamsChanged constructor
williamr@2
   123
*/
williamr@2
   124
	{
williamr@2
   125
	}
williamr@2
   126
williamr@2
   127
TInt CSubConGenEventParamsChanged::Error() const
williamr@2
   128
/** Gets Error value.
williamr@2
   129
williamr@2
   130
@return error value. */
williamr@2
   131
	{
williamr@2
   132
	return iError;
williamr@2
   133
	}
williamr@2
   134
williamr@2
   135
void CSubConGenEventParamsChanged::SetError(TInt aError)
williamr@2
   136
/** Sets Error value.
williamr@2
   137
williamr@2
   138
@param aError error value. */
williamr@2
   139
	{
williamr@2
   140
	iError = aError;
williamr@2
   141
	}
williamr@2
   142
williamr@2
   143
//====================================
williamr@2
   144
williamr@2
   145
CSubConGenEventParamsRejected* CSubConGenEventParamsRejected::NewL()
williamr@4
   146
/** Creates a rejected parameter event sub-connection.
williamr@2
   147
williamr@2
   148
@return CSubConGenEventParamsRejected pointer if successful,
williamr@2
   149
 otherwise leaves with system error code.
williamr@2
   150
*/
williamr@2
   151
	{
williamr@4
   152
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventParamsRejected);
williamr@2
   153
	return static_cast<CSubConGenEventParamsRejected*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
   154
	}
williamr@2
   155
williamr@2
   156
CSubConGenEventParamsRejected::CSubConGenEventParamsRejected()
williamr@2
   157
	: CSubConNotificationEvent()
williamr@2
   158
/** Empty CSubConGenEventParamsRejected constructor
williamr@2
   159
*/
williamr@2
   160
	{
williamr@2
   161
	}
williamr@2
   162
williamr@2
   163
TInt CSubConGenEventParamsRejected::Error() const
williamr@2
   164
/** Gets Error value.
williamr@2
   165
williamr@2
   166
@return error value. */
williamr@2
   167
	{
williamr@2
   168
	return iError;
williamr@2
   169
	}
williamr@2
   170
williamr@2
   171
void CSubConGenEventParamsRejected::SetError(TInt aError)
williamr@2
   172
/** Sets Error value.
williamr@2
   173
williamr@2
   174
@param aError error value. */
williamr@2
   175
	{
williamr@2
   176
	iError = aError;
williamr@2
   177
	}
williamr@2
   178
williamr@2
   179
TInt CSubConGenEventParamsRejected::FamilyId() const
williamr@2
   180
/** Gets parameter family type.
williamr@2
   181
williamr@2
   182
@return parameter family type. */
williamr@2
   183
	{
williamr@2
   184
	return iFamilyId;
williamr@2
   185
	}
williamr@2
   186
williamr@2
   187
void CSubConGenEventParamsRejected::SetFamilyId(TInt aFamilyId)
williamr@2
   188
/** Sets parameter family type.
williamr@2
   189
williamr@2
   190
@param aFamilyId parameter family type. */
williamr@2
   191
	{
williamr@2
   192
	iFamilyId = aFamilyId;
williamr@4
   193
	}
williamr@4
   194
williamr@2
   195
//====================================
williamr@2
   196
CSubConGenEventDataClientBase::CSubConGenEventDataClientBase()
williamr@2
   197
	: CSubConNotificationEvent()
williamr@2
   198
/** Empty CSubConGenEventDataClientBase constructor
williamr@2
   199
*/
williamr@2
   200
	{
williamr@2
   201
	}
williamr@2
   202
williamr@2
   203
TUint CSubConGenEventDataClientBase::GetIap() const
williamr@2
   204
/** Gets sub-connection's Internet Access Point.
williamr@2
   205
williamr@2
   206
@return Internet Access Point. */
williamr@2
   207
	{
williamr@2
   208
	return iIap;
williamr@2
   209
	}
williamr@2
   210
williamr@2
   211
void CSubConGenEventDataClientBase::SetIap(TUint aIap)
williamr@2
   212
/** Sets sub-connection's Internet Access Point.
williamr@2
   213
williamr@2
   214
@param aIap Internet Access Point. */
williamr@2
   215
	{
williamr@2
   216
	iIap = aIap;
williamr@2
   217
	}
williamr@2
   218
williamr@2
   219
const TSockAddr& CSubConGenEventDataClientBase::GetSourceAdress() const
williamr@2
   220
/** Gets sub-connection's source socket address.
williamr@2
   221
williamr@2
   222
@return Internet Access Point. */
williamr@2
   223
	{
williamr@2
   224
	return iSourceAddress;
williamr@2
   225
	}
williamr@2
   226
williamr@2
   227
void CSubConGenEventDataClientBase::SetSourceAddress(const TSockAddr& aSourceAddress)
williamr@2
   228
/** Sets sub-connection's source socket address.
williamr@2
   229
williamr@2
   230
@param aIap Internet Access Point. */
williamr@2
   231
	{
williamr@2
   232
	iSourceAddress = aSourceAddress;
williamr@2
   233
	}
williamr@2
   234
williamr@2
   235
const TSockAddr& CSubConGenEventDataClientBase::GetDestAdress() const
williamr@2
   236
/** Gets sub-connection's destination socket address.
williamr@2
   237
williamr@2
   238
@return Internet Access Point. */
williamr@2
   239
	{
williamr@2
   240
	return iDestAddress;
williamr@2
   241
	}
williamr@2
   242
williamr@2
   243
void CSubConGenEventDataClientBase::SetDestAddress(const TSockAddr& aDestAddress)
williamr@2
   244
/** Sets sub-connection's destination socket address.
williamr@2
   245
williamr@2
   246
@param aIap Internet Access Point. */
williamr@2
   247
	{
williamr@2
   248
	iDestAddress = aDestAddress;
williamr@2
   249
	}
williamr@2
   250
williamr@2
   251
//====================================
williamr@2
   252
CSubConGenEventDataClientJoined* CSubConGenEventDataClientJoined::NewL()
williamr@4
   253
/** Creates a data client joined event sub-connection.
williamr@2
   254
williamr@2
   255
@return CSubConGenEventDataClientJoined pointer if successful,
williamr@2
   256
 otherwise leaves with system error code.
williamr@2
   257
*/
williamr@2
   258
	{
williamr@4
   259
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventDataClientJoined);
williamr@2
   260
	return static_cast<CSubConGenEventDataClientJoined*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
   261
	}
williamr@2
   262
williamr@2
   263
CSubConGenEventDataClientJoined::CSubConGenEventDataClientJoined()
williamr@2
   264
	: CSubConGenEventDataClientBase()
williamr@2
   265
/** Empty CSubConGenEventDataClientJoined constructor
williamr@2
   266
*/
williamr@2
   267
	{
williamr@2
   268
	}
williamr@2
   269
williamr@2
   270
//=====================================
williamr@2
   271
CSubConGenEventDataClientLeft* CSubConGenEventDataClientLeft::NewL()
williamr@4
   272
/** Creates a data client left event sub-connection.
williamr@2
   273
williamr@2
   274
@return CSubConGenEventDataClientLeft pointer if successful,
williamr@2
   275
 otherwise leaves with system error code.
williamr@2
   276
*/
williamr@2
   277
	{
williamr@4
   278
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventDataClientLeft);
williamr@2
   279
	return static_cast<CSubConGenEventDataClientLeft*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
   280
	}
williamr@2
   281
williamr@2
   282
CSubConGenEventDataClientLeft::CSubConGenEventDataClientLeft()
williamr@2
   283
	: CSubConGenEventDataClientBase()
williamr@2
   284
/** Empty CSubConGenEventDataClientLeft constructor
williamr@2
   285
*/
williamr@2
   286
	{
williamr@2
   287
	}
williamr@2
   288
williamr@2
   289
//====================================
williamr@2
   290
CSubConGenEventSubConDown* CSubConGenEventSubConDown::NewL()
williamr@4
   291
/** Creates a sub-connection down event.
williamr@2
   292
williamr@2
   293
@return a CSubConGenEventSubConDown pointer if successful,
williamr@2
   294
 otherwise leaves with system error code.
williamr@2
   295
*/
williamr@2
   296
	{
williamr@4
   297
	STypeId typeId = STypeId::CreateSTypeId(KSubConnGenericEventsImplUid, KSubConGenericEventSubConDown);
williamr@2
   298
	return static_cast<CSubConGenEventSubConDown*>(CSubConNotificationEvent::NewL(typeId));
williamr@2
   299
	}
williamr@2
   300
williamr@2
   301
CSubConGenEventSubConDown::CSubConGenEventSubConDown()
williamr@2
   302
	: CSubConNotificationEvent()
williamr@2
   303
/** Empty CSubConGenEventSubConDown constructor
williamr@2
   304
*/
williamr@2
   305
	{
williamr@2
   306
	}
williamr@2
   307
williamr@2
   308
TInt CSubConGenEventSubConDown::Error() const
williamr@2
   309
/** Gets Error value.
williamr@2
   310
williamr@2
   311
@return error value. */
williamr@2
   312
	{
williamr@2
   313
	return iError;
williamr@2
   314
	}
williamr@2
   315
williamr@2
   316
void CSubConGenEventSubConDown::SetError(TInt aError)
williamr@2
   317
/** Sets Error value.
williamr@2
   318
williamr@2
   319
@param aError error value. */
williamr@2
   320
	{
williamr@2
   321
	iError = aError;
williamr@2
   322
	}
williamr@2
   323
williamr@2
   324
#endif	// __CS_SUBCONEVENTS_INL__
williamr@4
   325