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