Symbian^3 Application Developer Library >

CUpnpTimeoutElement Class Reference

class CUpnpTimeoutElement : public CActive

This is a virtual base class containing a timeout functionality. This class is used by following steps:

1. Inherit your class from CUpnpTimeoutElement ;

2. In the constructor of the derived class, call also the constructor of CUpnpTimeoutElement . This means you have to have an element library class which is derived from the class MUpnpTimeoutElementParent . This element library has to be passed to the constructor of CUpnpTimeoutElement .

3. Call the SetTimeout function to set the timeout of the element

4. If the timeout should be renewed after a timeout, call SetRenew to set the member variable iRenew. That variable can be used later to decide the destiny of an element.

Since
Series60 2.0

Inherits from

Public Member Functions
~CUpnpTimeoutElement ()
IMPORT_C void DoCancel ()
IMPORT_C TRenew & Renew ()
IMPORT_C TInt RunError ( TInt )
IMPORT_C void RunL ()
IMPORT_C void SetRenew ( TRenew )
IMPORT_C void SetTimeout ( TInt )
Protected Member Functions
CUpnpTimeoutElement ( MUpnpTimeoutElementParent &)
IMPORT_C void BaseConstructL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum TRenew { ERenew , EOnce , ERemove }
enum TState { EAlive , EDead , ELongTime }
Inherited Enumerations
CActive:TPriority
Private Attributes
const TUint32 KMicroInSec
const TInt KTime
MUpnpTimeoutElementParent & iParent
TRenew iRenew
TInt iSeconds
TState iState
RTimer iTimer
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CUpnpTimeoutElement(MUpnpTimeoutElementParent &)

IMPORT_C CUpnpTimeoutElement ( MUpnpTimeoutElementParent & aParent ) [protected]
Constructor function; call from the constructor of a derived class.
Since
Series60 2.0

Parameters

MUpnpTimeoutElementParent & aParent A class implementing the parent interface MUpnpTimeoutElementParent, in practice the library class

~CUpnpTimeoutElement()

IMPORT_C ~CUpnpTimeoutElement ( ) [virtual]

Destructor function; called automatically from the destructor of a derived class

Member Functions Documentation

BaseConstructL()

IMPORT_C void BaseConstructL ( ) [protected]
Base class constructor function
Since
Series60 2.0

DoCancel()

IMPORT_C void DoCancel ( ) [virtual]
Standard callback function of CActive-derived functions
Since
Series60 2.0

Renew()

IMPORT_C TRenew & Renew ( )
Returns the current renew setting
Since
Series60 2.0

RunError(TInt)

IMPORT_C TInt RunError ( TInt aError ) [virtual]
Standard callback function of CActive-derived functions
Since
Series60 2.0

Parameters

TInt aError

RunL()

IMPORT_C void RunL ( ) [virtual]
Standard callback function of CActive-derived functions
Since
Series60 2.0

SetRenew(TRenew)

IMPORT_C void SetRenew ( TRenew aRenew )
ets the renew setting of this element
Since
Series60 2.0

Parameters

TRenew aRenew The new renew setting

SetTimeout(TInt)

IMPORT_C void SetTimeout ( TInt aSeconds )
This function sets the timeout of the element. The TimeoutExpired() function of the parent of this element is called after the timeout
Since
Series60 2.0

Parameters

TInt aSeconds

Member Enumerations Documentation

Enum TRenew

Enumerators

ERenew
EOnce
ERemove

Enum TState

Enumerators

EAlive
EDead
ELongTime

Member Data Documentation

const TUint32 KMicroInSec

const TUint32 KMicroInSec [private, static]

const TInt KTime

const TInt KTime [private, static]

MUpnpTimeoutElementParent & iParent

MUpnpTimeoutElementParent & iParent [private]

TRenew iRenew

TRenew iRenew [private]

TInt iSeconds

TInt iSeconds [private]

TState iState

TState iState [private]

RTimer iTimer

RTimer iTimer [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.