Symbian^3 Application Developer Library >

CUpnpDeviceLibraryElement Class Reference

class CUpnpDeviceLibraryElement : public CUpnpTimeoutElement

This class has two main functionalities: 1. Timeout from CUpnpTimeoutElement 2. Buffers to store the data about a UPnP device

Since
Series60 2.0

Inherits from

Public Member Functions
~CUpnpDeviceLibraryElement ()
IMPORT_C TBool AddInfoL ( CUpnpSsdpMessage *, TInt &)
IMPORT_C void AddInfoL (const TUpnpAddLocalDevice *, const TDesC8 &, const TInetAddr &)
IMPORT_C void AddInfoL (const TUpnpAddLocalDevice *, const TDesC8 &)
TBool Advertised ()
void Advertising ()
void AdvertisingFinished ()
IMPORT_C TBool Alive ()
IMPORT_C TUpnpDevice * AsTDeviceL ()
IMPORT_C TDesC8 & DescriptionUrl ()
IMPORT_C TDesC8 & DeviceType ()
IMPORT_C TDesC8 & Domain ()
TBool Expired ()
TBool Filter ()
IMPORT_C TBool IsRootDevice ()
IMPORT_C TBool Local ()
IMPORT_C CUpnpDeviceLibraryElement * NewL ( MUpnpTimeoutElementParent &)
IMPORT_C CDesC8Array & ServiceList ()
IMPORT_C void SetAlive ( TBool )
void SetExpired ( TBool )
void SetFilter ( TBool )
void SetLocal ( TBool )
void SetRootDevice ( TBool )
IMPORT_C void SetUpdateId ( TInt )
IMPORT_C TDesC8 & UUID ()
IMPORT_C TInt UpdateId ()
Private Member Functions
CUpnpDeviceLibraryElement ( MUpnpTimeoutElementParent &)
TBool AddInfoFromNotificationTypeHeaderL ( CUpnpSsdpMessage *)
void AddServiceTypeL (const TDesC8 &)
void ConstructL ()
TBool HasPrefix (const TDesC8 &, const TDesC8 &)
void SetDescriptionUrlL (const TDesC8 &)
void SetDescriptionUrlL (const TDesC8 &, const TInetAddr &, const TDesC8 &)
void SetDeviceTypeL (const TDesC8 &)
void SetDomainL (const TDesC8 &)
void SetUuidL (const TDesC8 &)
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()
CUpnpTimeoutElement::BaseConstructL()
CUpnpTimeoutElement::CUpnpTimeoutElement(MUpnpTimeoutElementParent &)
CUpnpTimeoutElement::DoCancel()
CUpnpTimeoutElement::Renew()
CUpnpTimeoutElement::RunError(TInt)
CUpnpTimeoutElement::RunL()
CUpnpTimeoutElement::SetRenew(TRenew)
CUpnpTimeoutElement::SetTimeout(TInt)
CUpnpTimeoutElement::~CUpnpTimeoutElement()
Inherited Enumerations
CActive:TPriority
CUpnpTimeoutElement:TRenew
CUpnpTimeoutElement:TState
Protected Attributes
TInt iUpdateId
Private Attributes
TBool iAdvertised
TBool iAlive
HBufC8 * iDescriptionURL
HBufC8 * iDeviceType
HBufC8 * iDomain
TBool iExpired
TBool iFilter
TBool iLocal
TBool iRootDevice
CDesC8ArrayFlat * iServiceList
HBufC8 * iUUID
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

CUpnpDeviceLibraryElement(MUpnpTimeoutElementParent &)

CUpnpDeviceLibraryElement ( MUpnpTimeoutElementParent & aParent ) [private]

C++ default constructor.

Parameters

MUpnpTimeoutElementParent & aParent The parent of the element (e.g. device library) to handle timeout callbacks

~CUpnpDeviceLibraryElement()

IMPORT_C ~CUpnpDeviceLibraryElement ( ) [virtual]

Destructor.

Member Functions Documentation

AddInfoFromNotificationTypeHeaderL(CUpnpSsdpMessage *)

TBool AddInfoFromNotificationTypeHeaderL ( CUpnpSsdpMessage * aMessage ) [private]

Add data (only from Notification Type Header) of a SSDP message to the device library

Parameters

CUpnpSsdpMessage * aMessage A SSDP message

AddInfoL(CUpnpSsdpMessage *, TInt &)

IMPORT_C TBool AddInfoL ( CUpnpSsdpMessage * aMessage,
TInt & aUpdateId
)
Add data of a SSDP message to the device library
Since
Series60 2.0

Parameters

CUpnpSsdpMessage * aMessage A SSDP message
TInt & aUpdateId Reference to current update id. If required \ the value of this update id is changed when device is added to \ device library.

AddInfoL(const TUpnpAddLocalDevice *, const TDesC8 &, const TInetAddr &)

IMPORT_C void AddInfoL ( const TUpnpAddLocalDevice * aIndex,
const TDesC8 & aBuffer,
const TInetAddr & aAddr
)
Add data got from local device to the device library.
Since
Series60 2.0

Parameters

const TUpnpAddLocalDevice * aIndex A indexing structure for the data buffer
const TDesC8 & aBuffer A buffer containing the actual data
const TInetAddr & aAddr Address of the device that is to be added.

AddInfoL(const TUpnpAddLocalDevice *, const TDesC8 &)

IMPORT_C void AddInfoL ( const TUpnpAddLocalDevice * aIndex,
const TDesC8 & aBuffer
)
Add data got from local device to the device library.
Since
Series60 2.0

Parameters

const TUpnpAddLocalDevice * aIndex A indexing structure for the data buffer
const TDesC8 & aBuffer A buffer containing the actual data

AddServiceTypeL(const TDesC8 &)

void AddServiceTypeL ( const TDesC8 & aServiceType ) [private]
Adds a service to this element. Service type is aServiceType (ConnectionManager:1 for example).
Since
Series60 2.0

Parameters

const TDesC8 & aServiceType Name of service that is to be added.

Advertised()

TBool Advertised ( )
Is advertised.
Since
Series60 3.2

Advertising()

void Advertising ( )
Sets iAdvertised to ETrue.
Since
Series60 3.2

AdvertisingFinished()

void AdvertisingFinished ( )
Sets iAdvertised to EFalse.
Since
S60 5.1

Alive()

IMPORT_C TBool Alive ( ) const
Is alive.
Since
Series60 2.0

AsTDeviceL()

IMPORT_C TUpnpDevice * AsTDeviceL ( ) const
?member_description.
Since
Series60 2.0

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

DescriptionUrl()

IMPORT_C TDesC8 & DescriptionUrl ( )
Returns the description URL of this element.
Since
Series60 2.0

DeviceType()

IMPORT_C TDesC8 & DeviceType ( )
Returns the device type of this element.
Since
Series60 2.0

Domain()

IMPORT_C TDesC8 & Domain ( )
Returns the domain of this element.
Since
Series60 2.0

Expired()

TBool Expired ( ) const
Idicate if device cache-control time expired.
Since
Series60 3.2

Filter()

TBool Filter ( ) const
Should be filtered.
Since
Series60 3.2

HasPrefix(const TDesC8 &, const TDesC8 &)

TBool HasPrefix ( const TDesC8 & aDescriptor,
const TDesC8 & aPrefix
) [private, static]

Check if a aDescriptor has prefix aPrefix

Parameters

const TDesC8 & aDescriptor
const TDesC8 & aPrefix

IsRootDevice()

IMPORT_C TBool IsRootDevice ( ) const
Returns true, if the element describes a root device.
Since
Series60 2.0

Local()

IMPORT_C TBool Local ( ) const
Return local.
Since
Series60 2.0

NewL(MUpnpTimeoutElementParent &)

IMPORT_C CUpnpDeviceLibraryElement * NewL ( MUpnpTimeoutElementParent & aParent ) [static]

Two-phased constructor.

Parameters

MUpnpTimeoutElementParent & aParent The parent of the element (e.g. device library) to handle timeout callbacks

ServiceList()

IMPORT_C CDesC8Array & ServiceList ( )
Returns an array containing the service types of the services of this element.
Since
Series60 2.0

SetAlive(TBool)

IMPORT_C void SetAlive ( TBool aAlive )
SetAlive.
Since
Series60 2.0

Parameters

TBool aAlive

SetDescriptionUrlL(const TDesC8 &)

void SetDescriptionUrlL ( const TDesC8 & aDescriptionURL ) [private]
Sets the url to this device's description file.
Since
Series60 2.0

Parameters

const TDesC8 & aDescriptionURL New value of description url.

SetDescriptionUrlL(const TDesC8 &, const TInetAddr &, const TDesC8 &)

void SetDescriptionUrlL ( const TDesC8 & aDescriptionURL,
const TInetAddr & aAddr,
const TDesC8 & aPort
) [private]

Sets the url to this device's description file.

Parameters

const TDesC8 & aDescriptionURL New value of description url.
const TInetAddr & aAddr Address of the device.
const TDesC8 & aPort Port of the device.

SetDeviceTypeL(const TDesC8 &)

void SetDeviceTypeL ( const TDesC8 & aDeviceType ) [private]
Sets the device's type (for example MediaServer:1).
Since
Series60 2.0

Parameters

const TDesC8 & aDeviceType New value for device type.

SetDomainL(const TDesC8 &)

void SetDomainL ( const TDesC8 & aDomain ) [private]
Sets the domain value for this element.
Since
Series60 2.0

Parameters

const TDesC8 & aDomain New value for Domain.

SetExpired(TBool)

void SetExpired ( TBool aExpired )
Setter.
Since
Series60 3.2

Parameters

TBool aExpired

SetFilter(TBool)

void SetFilter ( TBool aFilter )
SetFilter.
Since
Series60 2.0

Parameters

TBool aFilter

SetLocal(TBool)

void SetLocal ( TBool aLocal )
Set local.
Since
Series60 2.0

Parameters

TBool aLocal if local or not

SetRootDevice(TBool)

void SetRootDevice ( TBool aRootDevice )
Set root device.
Since
Series60 2.0

Parameters

TBool aRootDevice root device

SetUpdateId(TInt)

IMPORT_C void SetUpdateId ( TInt aUpdateId )
Set update id.
Since
Series60 2.0

Parameters

TInt aUpdateId update ID

SetUuidL(const TDesC8 &)

void SetUuidL ( const TDesC8 & aUUID ) [private]
Sets the UUID of a device to aUUID.
Since
Series60 2.0

Parameters

const TDesC8 & aUUID UUID value that is to be set for this element.

UUID()

IMPORT_C TDesC8 & UUID ( )
Returns the UUID of this element.
Since
Series60 2.0

UpdateId()

IMPORT_C TInt UpdateId ( ) const
Return update ID.
Since
Series60 2.0

Member Data Documentation

TBool iAdvertised

TBool iAdvertised [private]

TBool iAlive

TBool iAlive [private]

HBufC8 * iDescriptionURL

HBufC8 * iDescriptionURL [private]

HBufC8 * iDeviceType

HBufC8 * iDeviceType [private]

HBufC8 * iDomain

HBufC8 * iDomain [private]

TBool iExpired

TBool iExpired [private]

TBool iFilter

TBool iFilter [private]

TBool iLocal

TBool iLocal [private]

TBool iRootDevice

TBool iRootDevice [private]

CDesC8ArrayFlat * iServiceList

CDesC8ArrayFlat * iServiceList [private]

HBufC8 * iUUID

HBufC8 * iUUID [private]

TInt iUpdateId

TInt iUpdateId [protected]

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.