Symbian^3 Application Developer Library >

CUpnpSsdpMessage Class Reference

class CUpnpSsdpMessage : public CUpnpHttpMessage

Ssdp-Message class. Used in sending and handling Ssdp messages.

Since
Series60 2.0

Inherits from

Public Member Functions
~CUpnpSsdpMessage ()
void AddCacheControlL ( TDesC8 &)
IMPORT_C void AddHostL ( TDesC8 &)
void AddLocationL ( TDesC8 &)
IMPORT_C void AddMxL ( TDesC8 &)
void AddNotificationTypeL ( TDesC8 &)
void AddSearchTargetStringL ( TDesC8 &)
void AddServerL ( TDesC8 &)
void AddUsnL ( TDesC8 &)
IMPORT_C TInt CacheControl ()
IMPORT_C TBool IsSearchAll ()
IMPORT_C TBool IsSearchDevice ()
IMPORT_C TBool IsSearchService ()
IMPORT_C TBool IsSsdpAlive ()
IMPORT_C TBool IsSsdpByebye ()
IMPORT_C TBool IsSsdpMSearch ()
IMPORT_C TBool IsSsdpNotify ()
IMPORT_C TBool IsSsdpResponse ()
IMPORT_C TDesC8 & Location ()
IMPORT_C CUpnpSsdpMessage * NewL ( TInetAddr &, TRequestType )
IMPORT_C CUpnpSsdpMessage * NewL ( TRequestType )
IMPORT_C CUpnpSsdpMessage * NewL ( TDesC8 &, TInetAddr &)
IMPORT_C TDesC8 & Nt ()
IMPORT_C TDesC8 & Nts ()
IMPORT_C TInt SearchTarget ()
IMPORT_C TDesC8 & St ()
HBufC8 * ToStringL ()
IMPORT_C TDesC8 & Usn ()
IMPORT_C TPtr8 Uuid ()
Protected Member Functions
IMPORT_C void AppendContentLengthToHeadersL ( HBufC8 *&)
Private Member Functions
CUpnpSsdpMessage ()
void ConstructL ( TRequestType )
void HttpConstructL ( TInetAddr &)
void ParseL ( TDesC8 &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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()
CUpnpHttpMessage::AddPairL(const TDesC8 &,const TDesC8 &)
CUpnpHttpMessage::AddrInput(TInetAddr &,const TDesC8 &)
CUpnpHttpMessage::AddrOutput(const TInetAddr &,TDes8 &)
CUpnpHttpMessage::Body()
CUpnpHttpMessage::BodyLength()const
CUpnpHttpMessage::CUpnpHttpMessage()
CUpnpHttpMessage::CancelMessageTimeout()
CUpnpHttpMessage::ClientRequest()
CUpnpHttpMessage::ConstructL()
CUpnpHttpMessage::ConstructL(TInetAddr &,TInt)
CUpnpHttpMessage::DestinationPath()
CUpnpHttpMessage::DevicePath()
CUpnpHttpMessage::Error()
CUpnpHttpMessage::FindLWS(const TDesC8 &)
CUpnpHttpMessage::FoldHeaderL(HBufC8 *&)
CUpnpHttpMessage::GetHeaderValue(const TDesC8 &)
CUpnpHttpMessage::HeaderList()
CUpnpHttpMessage::HeadersToStringL()
CUpnpHttpMessage::HttpError(THttpStatusCode)
CUpnpHttpMessage::HttpPriority()
CUpnpHttpMessage::InFilename()
CUpnpHttpMessage::InternalError()
CUpnpHttpMessage::Is1xx()
CUpnpHttpMessage::Is2xx()
CUpnpHttpMessage::Is3xx()
CUpnpHttpMessage::IsGena()
CUpnpHttpMessage::IsHeader(const TDesC8 &,TBool &)
CUpnpHttpMessage::IsSoap()const
CUpnpHttpMessage::Length()
CUpnpHttpMessage::Local()
CUpnpHttpMessage::Method()
CUpnpHttpMessage::NewL()
CUpnpHttpMessage::NewL(TDesC8 &,TInetAddr)
CUpnpHttpMessage::NewL(TDesC8 &,const TInetAddr &,TInt)
CUpnpHttpMessage::NewL(TInetAddr,TInt)
CUpnpHttpMessage::NewL(const TInetAddr &)
CUpnpHttpMessage::NewSessionIdL()
CUpnpHttpMessage::Offset()
CUpnpHttpMessage::OutFilename()
CUpnpHttpMessage::OutUri()
CUpnpHttpMessage::OverwriteExisting()
CUpnpHttpMessage::ParseHeaderRowL(const TDesC8 &,TBool)
CUpnpHttpMessage::PendingRequest()
CUpnpHttpMessage::Receiver()
CUpnpHttpMessage::RemovePairL(const TDesC8 &)
CUpnpHttpMessage::RequestHTTPVersion()
CUpnpHttpMessage::RetryCounter()
CUpnpHttpMessage::SaveAtOffset()
CUpnpHttpMessage::Sender()
CUpnpHttpMessage::SenderPath()
CUpnpHttpMessage::SenderPathFromHeader()
CUpnpHttpMessage::ServicePath()const
CUpnpHttpMessage::SessionId()const
CUpnpHttpMessage::SessionIdMatch(const CUpnpHttpMessage &,const CUpnpHttpMessage &)
CUpnpHttpMessage::SetBodyL(const TDesC8 &)
CUpnpHttpMessage::SetClientRequest(TBool)
CUpnpHttpMessage::SetDestinationPathL(const TDesC8 &)
CUpnpHttpMessage::SetHttpPriority(TThreadPriority)
CUpnpHttpMessage::SetInFilenameL(const TDesC8 &,TBool)
CUpnpHttpMessage::SetInternalError(TInt)
CUpnpHttpMessage::SetLocal(TBool)
CUpnpHttpMessage::SetMessageDateL(const TTime &)
CUpnpHttpMessage::SetMessageTimeoutL(MUpnpMessageObserver *,const TInt)
CUpnpHttpMessage::SetOutFilenameL(const TDesC8 &)
CUpnpHttpMessage::SetOutUriL(const TDesC8 &)
CUpnpHttpMessage::SetPendingRequest(TAny *)
CUpnpHttpMessage::SetRangeL(TInt,TInt,TBool)
CUpnpHttpMessage::SetRetryCounter(TInt)
CUpnpHttpMessage::SetSenderPathL(const TDesC8 &)
CUpnpHttpMessage::SetSessionId(TInt)
CUpnpHttpMessage::SetTcpTimeout(TInt)
CUpnpHttpMessage::SetType(THTTPMsgType)
CUpnpHttpMessage::TcpTimeout()
CUpnpHttpMessage::TimerEventL(CUpnpNotifyTimer *)
CUpnpHttpMessage::Type()const
CUpnpHttpMessage::UnFoldHeader(HBufC8 *&)
CUpnpHttpMessage::UpnpError(TUpnpErrorCode)
CUpnpHttpMessage::UpnpErrorL(TUpnpErrorCode)
CUpnpHttpMessage::~CUpnpHttpMessage()
Public Member Enumerations
enum TRequestType { ERequestNotify  = 1, ERequestByeBye , ERequestSearch , ERequestSearchResponse , ERequestUndefined }
enum TSearchTarget {
ESsdpNone  = 1, ESsdpAll , EUPnPRootDevice , EDeviceUid , EDeviceType , EServiceType
}
Inherited Attributes
CUpnpHttpMessage::iClientRequest
CUpnpHttpMessage::iDestinationPath
CUpnpHttpMessage::iHeaderList
CUpnpHttpMessage::iInFilename
CUpnpHttpMessage::iInternalError
CUpnpHttpMessage::iLength
CUpnpHttpMessage::iLocal
CUpnpHttpMessage::iMessageObserver
CUpnpHttpMessage::iOffset
CUpnpHttpMessage::iOutFilename
CUpnpHttpMessage::iOutUri
CUpnpHttpMessage::iOverwriteExisting
CUpnpHttpMessage::iPendingRequest
CUpnpHttpMessage::iRemoteHost
CUpnpHttpMessage::iRetryCounter
CUpnpHttpMessage::iSaveAtOffset
CUpnpHttpMessage::iSenderPath
CUpnpHttpMessage::iSessionId
CUpnpHttpMessage::iSessionPriority
CUpnpHttpMessage::iTcpTimeout
CUpnpHttpMessage::iTextBody
CUpnpHttpMessage::iTimer
CUpnpHttpMessage::iType

Constructor & Destructor Documentation

CUpnpSsdpMessage()

CUpnpSsdpMessage ( ) [private]

C++ default constructor.

~CUpnpSsdpMessage()

IMPORT_C ~CUpnpSsdpMessage ( )

Destructor.

Member Functions Documentation

AddCacheControlL(TDesC8 &)

void AddCacheControlL ( TDesC8 & aMaxAge )
Sets the Cache-control-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aMaxAge Value of Cache-Control to be set.

AddHostL(TDesC8 &)

IMPORT_C void AddHostL ( TDesC8 & aHost )
Sets the host-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aHost Value of host to be set.

AddLocationL(TDesC8 &)

void AddLocationL ( TDesC8 & aDescriptionLocation )
Sets the Description-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aDescriptionLocation Value of description to be set.

AddMxL(TDesC8 &)

IMPORT_C void AddMxL ( TDesC8 & aMx )
Sets the MX-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aMx Value of MX to be set.

AddNotificationTypeL(TDesC8 &)

void AddNotificationTypeL ( TDesC8 & aNT )
Sets the NT-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aNT Value of NT to be set.

AddSearchTargetStringL(TDesC8 &)

void AddSearchTargetStringL ( TDesC8 & aSt )
Sets the ST-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aSt Value of ST to be set.

AddServerL(TDesC8 &)

void AddServerL ( TDesC8 & aServerType )
Sets the Server description-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aServerType Value of server description to be set.

AddUsnL(TDesC8 &)

void AddUsnL ( TDesC8 & aUsn )
Sets the USN-header of Ssdp message.
Since
Series60 2.0

Parameters

TDesC8 & aUsn Value of USN to be set.

AppendContentLengthToHeadersL(HBufC8 *&)

IMPORT_C void AppendContentLengthToHeadersL ( HBufC8 *& aHeaders ) [protected, virtual]

Append ContentLength when headers are dumped to string (using public method HeadersToStringL)

Parameters

HBufC8 *& aHeaders without "Content-Length"

CacheControl()

IMPORT_C TInt CacheControl ( )
Cache control.
Since
Series60 2.0

ConstructL(TRequestType)

void ConstructL ( TRequestType aRequestType ) [private]

By default Symbian 2nd phase constructor is private.

Parameters

TRequestType aRequestType Type of message to be constructed.

HttpConstructL(TInetAddr &)

void HttpConstructL ( TInetAddr & aAddr ) [private]

By default Symbian 2nd phase constructor is private.

Parameters

TInetAddr & aAddr Remote IP address

IsSearchAll()

IMPORT_C TBool IsSearchAll ( )
Return if search all.
Since
Series60 2.0

IsSearchDevice()

IMPORT_C TBool IsSearchDevice ( )
Return if search device.
Since
Series60 2.0

IsSearchService()

IMPORT_C TBool IsSearchService ( )
Return if search service.
Since
Series60 2.0

IsSsdpAlive()

IMPORT_C TBool IsSsdpAlive ( )
Returns ETrue, if message is a Alive-message, else returns EFalse.
Since
Series60 2.0

IsSsdpByebye()

IMPORT_C TBool IsSsdpByebye ( )
Returns ETrue, if message is a Byebye-message, else returns EFalse.
Since
Series60 2.0

IsSsdpMSearch()

IMPORT_C TBool IsSsdpMSearch ( )
Returns ETrue, if message is a search message, else returns EFalse.
Since
Series60 2.0

IsSsdpNotify()

IMPORT_C TBool IsSsdpNotify ( )
Returns if SSDP notify.
Since
Series60 2.0

IsSsdpResponse()

IMPORT_C TBool IsSsdpResponse ( )
Return if SSDP response.
Since
Series60 2.0

Location()

IMPORT_C TDesC8 & Location ( )
Return location
Since
Series60 2.0

NewL(TInetAddr &, TRequestType)

IMPORT_C CUpnpSsdpMessage * NewL ( TInetAddr & aAddr,
TRequestType aRequestType
) [static]

Two-phased constructor.

Parameters

TInetAddr & aAddr Sender's IP address.
TRequestType aRequestType Type of message to be constructed.

NewL(TRequestType)

IMPORT_C CUpnpSsdpMessage * NewL ( TRequestType aRequestType ) [static]

Two-phased constructor.

Parameters

TRequestType aRequestType Type of message to be constructed.

NewL(TDesC8 &, TInetAddr &)

IMPORT_C CUpnpSsdpMessage * NewL ( TDesC8 & aBuffer,
TInetAddr & aAddr
) [static]

Two-phased constructor.

Parameters

TDesC8 & aBuffer Buffer which contains the message.
TInetAddr & aAddr Target IP address.

Nt()

IMPORT_C TDesC8 & Nt ( )
Returns NT-header of Ssdp message.
Since
Series60 2.0

Nts()

IMPORT_C TDesC8 & Nts ( )
Returns NTS-header of Ssdp message.
Since
Series60 2.0

ParseL(TDesC8 &)

void ParseL ( TDesC8 & aBuffer ) [private, virtual]
Parse buffer.
Since
Series60 2.0

Parameters

TDesC8 & aBuffer buffer to be parsed.

SearchTarget()

IMPORT_C TInt SearchTarget ( )
Search target.
Since
Series60 2.0

St()

IMPORT_C TDesC8 & St ( )
Returns ST-header of Ssdp message.
Since
Series60 2.0

ToStringL()

HBufC8 * ToStringL ( ) [virtual]
Buffer to string.
Since
Series60 2.0

Usn()

IMPORT_C TDesC8 & Usn ( )
Returns USN-header of Ssdp message.
Since
Series60 2.0

Uuid()

IMPORT_C TPtr8 Uuid ( )
Return UUID
Since
Series60 2.0

Member Enumerations Documentation

Enum TRequestType

Enumeration for message types:

Enumerators

ERequestNotify = 1
ERequestByeBye
ERequestSearch
ERequestSearchResponse
ERequestUndefined

Enum TSearchTarget

Enumeration for search message types:
Since
Series60 2.0

Enumerators

ESsdpNone = 1
ESsdpAll
EUPnPRootDevice
EDeviceUid
EDeviceType
EServiceType

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.