Symbian^3 Product 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 TBoolAddInfoL(CUpnpSsdpMessage *, TInt &)
IMPORT_C voidAddInfoL(const TUpnpAddLocalDevice *, const TDesC8 &, const TInetAddr &)
IMPORT_C voidAddInfoL(const TUpnpAddLocalDevice *, const TDesC8 &)
TBool Advertised()
voidAdvertising()
voidAdvertisingFinished()
IMPORT_C TBoolAlive()
IMPORT_C TUpnpDevice *AsTDeviceL()
IMPORT_C TDesC8 &DescriptionUrl()
IMPORT_C TDesC8 &DeviceType()
IMPORT_C TDesC8 &Domain()
TBool Expired()
TBool Filter()
IMPORT_C TBoolIsRootDevice()
IMPORT_C TBoolLocal()
IMPORT_C CUpnpDeviceLibraryElement *NewL(MUpnpTimeoutElementParent &)
IMPORT_C CDesC8Array &ServiceList()
IMPORT_C voidSetAlive(TBool)
voidSetExpired(TBool)
voidSetFilter(TBool)
voidSetLocal(TBool)
voidSetRootDevice(TBool)
IMPORT_C voidSetUpdateId(TInt)
IMPORT_C TDesC8 &UUID()
IMPORT_C TIntUpdateId()
Private Member Functions
CUpnpDeviceLibraryElement(MUpnpTimeoutElementParent &)
TBool AddInfoFromNotificationTypeHeaderL(CUpnpSsdpMessage *)
voidAddServiceTypeL(const TDesC8 &)
voidConstructL()
TBool HasPrefix(const TDesC8 &, const TDesC8 &)
voidSetDescriptionUrlL(const TDesC8 &)
voidSetDescriptionUrlL(const TDesC8 &, const TInetAddr &, const TDesC8 &)
voidSetDeviceTypeL(const TDesC8 &)
voidSetDomainL(const TDesC8 &)
voidSetUuidL(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 & aParentThe 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 * aMessageA SSDP message

AddInfoL(CUpnpSsdpMessage *, TInt &)

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

Parameters

CUpnpSsdpMessage * aMessageA SSDP message
TInt & aUpdateIdReference 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 voidAddInfoL(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 * aIndexA indexing structure for the data buffer
const TDesC8 & aBufferA buffer containing the actual data
const TInetAddr & aAddrAddress of the device that is to be added.

AddInfoL(const TUpnpAddLocalDevice *, const TDesC8 &)

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

Parameters

const TUpnpAddLocalDevice * aIndexA indexing structure for the data buffer
const TDesC8 & aBufferA buffer containing the actual data

AddServiceTypeL(const TDesC8 &)

voidAddServiceTypeL(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 & aServiceTypeName of service that is to be added.

Advertised()

TBool Advertised()
Is advertised.
Since
Series60 3.2

Advertising()

voidAdvertising()
Sets iAdvertised to ETrue.
Since
Series60 3.2

AdvertisingFinished()

voidAdvertisingFinished()
Sets iAdvertised to EFalse.
Since
S60 5.1

Alive()

IMPORT_C TBoolAlive()const
Is alive.
Since
Series60 2.0

AsTDeviceL()

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

ConstructL()

voidConstructL()[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 TBoolIsRootDevice()const
Returns true, if the element describes a root device.
Since
Series60 2.0

Local()

IMPORT_C TBoolLocal()const
Return local.
Since
Series60 2.0

NewL(MUpnpTimeoutElementParent &)

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

Two-phased constructor.

Parameters

MUpnpTimeoutElementParent & aParentThe 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 voidSetAlive(TBoolaAlive)
SetAlive.
Since
Series60 2.0

Parameters

TBool aAlive

SetDescriptionUrlL(const TDesC8 &)

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

Parameters

const TDesC8 & aDescriptionURLNew value of description url.

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

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

Sets the url to this device's description file.

Parameters

const TDesC8 & aDescriptionURLNew value of description url.
const TInetAddr & aAddrAddress of the device.
const TDesC8 & aPortPort of the device.

SetDeviceTypeL(const TDesC8 &)

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

Parameters

const TDesC8 & aDeviceTypeNew value for device type.

SetDomainL(const TDesC8 &)

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

Parameters

const TDesC8 & aDomainNew value for Domain.

SetExpired(TBool)

voidSetExpired(TBoolaExpired)
Setter.
Since
Series60 3.2

Parameters

TBool aExpired

SetFilter(TBool)

voidSetFilter(TBoolaFilter)
SetFilter.
Since
Series60 2.0

Parameters

TBool aFilter

SetLocal(TBool)

voidSetLocal(TBoolaLocal)
Set local.
Since
Series60 2.0

Parameters

TBool aLocalif local or not

SetRootDevice(TBool)

voidSetRootDevice(TBoolaRootDevice)
Set root device.
Since
Series60 2.0

Parameters

TBool aRootDeviceroot device

SetUpdateId(TInt)

IMPORT_C voidSetUpdateId(TIntaUpdateId)
Set update id.
Since
Series60 2.0

Parameters

TInt aUpdateIdupdate ID

SetUuidL(const TDesC8 &)

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

Parameters

const TDesC8 & aUUIDUUID 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 TIntUpdateId()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.