Collapse all Symbian^3 Product Developer Library

CUpnpAction Class Reference

class CUpnpAction : public CBase

Used to make a common body for actions. \ This class is only used when an action is sent or received. \ This class makes a common body for actions, which can then be modified by user. \

Since: Series60 2.6

Inherits from

CUpnpAction
- CBase

Public Member Functions
	~CUpnpAction()
void	AddArgumentL(CUpnpArgument &)
IMPORT_C CUpnpArgument *	Argument(const TDesC8 &)
IMPORT_C RPointerArray< CUpnpArgument > &	ArgumentList()
IMPORT_C TInt	ArgumentType(const TDesC8 &)
IMPORT_C const TDesC8 &	ArgumentValue(const TDesC8 &)
void	ConstructL()
IMPORT_C TInetAddr	DestinationAddr()
IMPORT_C const TDesC8 &	DestinationPath()
IMPORT_C TInt	Error()
IMPORT_C TBool	Local()
IMPORT_C TDesC8 &	Name()
IMPORT_C CUpnpAction *	NewL(const TDesC8 &)
CUpnpAction *	NewL(CUpnpService &)
IMPORT_C CUpnpAction *	NewLC(CUpnpAction &, CUpnpService &)
IMPORT_C TInetAddr &	Sender()
IMPORT_C CUpnpService &	Service()
IMPORT_C TDesC8 &	ServiceType()
IMPORT_C TInt	SessionId()
IMPORT_C TInt	SetArgumentL(const TDesC8 &, const TDesC8 &)
IMPORT_C void	SetDestinationAddr(const TInetAddr &)
IMPORT_C void	SetDestinationPathL(const TDesC8 &)
IMPORT_C void	SetError(TInt)
IMPORT_C void	SetLocal(TBool)
void	SetNameL(const TDesC8 &)
IMPORT_C void	SetSender(const TInetAddr &)
void	SetSessionId(TInt)

Private Member Functions
	CUpnpAction(CUpnpService &)
	CUpnpAction()
void	ConstructL(CUpnpAction &)

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()

Private Attributes
RPointerArray< CUpnpArgument >	iArguments
TInetAddr	iDestinationAddr
HBufC8 *	iDestinationPath
TInt	iError
TInt	iLocal
HBufC8 *	iName
CUpnpService &	iParentService
TInetAddr	iSender
TInt	iSessionId

Constructor & Destructor Documentation

CUpnpAction(CUpnpService &)

CUpnpAction

(

CUpnpService &

aParentService

)

[private]

C++ default constructor.

Parameters

CUpnpService & aParentService

Parent service.

CUpnpAction()

CUpnpAction

(

)

[private]

C++ default constructor.

~CUpnpAction()

IMPORT_C

~CUpnpAction

(

)

[virtual]

Destructor.

Member Functions Documentation

AddArgumentL(CUpnpArgument &)

void

AddArgumentL

(

CUpnpArgument &

aAction

)

Parameters

CUpnpArgument & aAction

Argument(const TDesC8 &)

IMPORT_C CUpnpArgument *

Argument

(

const TDesC8 &

aName

)

Returns the argument.

Since: Series60 2.6

Parameters

const TDesC8 & aName

Name of the argument.

ArgumentList()

IMPORT_C RPointerArray< CUpnpArgument > &

ArgumentList

(

)

Get argument list

Since: Series60 2.6

ArgumentType(const TDesC8 &)

IMPORT_C TInt

ArgumentType

(

const TDesC8 &

aArgumentName

)

Get argument tyoe

Since: Series60 2.6

Parameters

const TDesC8 & aArgumentName

Name of the argument.

ArgumentValue(const TDesC8 &)

IMPORT_C const TDesC8 &

ArgumentValue

(

const TDesC8 &

aName

)

Modifies an existing argument of the action.

Since: Series60 2.6

Parameters

const TDesC8 & aName

Name of the argument.

ConstructL()

void

ConstructL

(

)

ConstructL(CUpnpAction &)

void

ConstructL

(

CUpnpAction &

aAction

)

[private]

By default Symbian 2nd phase constructor is private. Adds the arguments and their default values according to the XML node

Parameters

CUpnpAction & aAction

DestinationAddr()

IMPORT_C TInetAddr

DestinationAddr

(

)

const

Get destination address

Since: Series60 2.6

DestinationPath()

IMPORT_C const TDesC8 &

DestinationPath

(

)

Get destination path

Since: Series60 2.6

Error()

IMPORT_C TInt

Error

(

)

const

Getter.

Since: Series60 2.6

Local()

IMPORT_C TBool

Local

(

)

const

Returns whether an action is local, comes from local control point.

Since: Series60 2.6

Name()

IMPORT_C TDesC8 &

Name

(

)

Get action name

Since: Series60 2.6

NewL(const TDesC8 &)

IMPORT_C CUpnpAction *

NewL

(

const TDesC8 &

aActionName

)

[static]

Construct action ONLY with specified name (not completely valid object) for TEST use only.

Parameters

const TDesC8 & aActionName

NewL(CUpnpService &)

CUpnpAction *

NewL

(

CUpnpService &

aParentService

)

[static]

Parameters

CUpnpService & aParentService

NewLC(CUpnpAction &, CUpnpService &)

IMPORT_C CUpnpAction *	NewLC	(	CUpnpAction &	aAction,
			CUpnpService &	aParentService
		)	[static]

Two-phased constructor for building from a XML node. Adds the arguments and their default values according to the XML node.

Parameters

CUpnpAction & aAction
CUpnpService & aParentService

Sender()

IMPORT_C TInetAddr &

Sender

(

)

Get source address of sender address

Since: Series60 2.6

Service()

IMPORT_C CUpnpService &

Service

(

)

Get service

Since: Series60 2.6

ServiceType()

IMPORT_C TDesC8 &

ServiceType

(

)

Get service type

Since: Series60 2.6

SessionId()

IMPORT_C TInt

SessionId

(

)

const

Get session ID

Since: Series60 2.6

SetArgumentL(const TDesC8 &, const TDesC8 &)

IMPORT_C TInt	SetArgumentL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue
		)

Modifies an existing argument of the action.

Since: Series60 2.6

Parameters

const TDesC8 & aName	the name of the argument.
const TDesC8 & aValue	the value of the argument.

SetDestinationAddr(const TInetAddr &)

IMPORT_C void

SetDestinationAddr

(

const TInetAddr &

aAddr

)

Set destination address

Since: Series60 2.6

Parameters

const TInetAddr & aAddr

Destination address of the action.

SetDestinationPathL(const TDesC8 &)

IMPORT_C void

SetDestinationPathL

(

const TDesC8 &

aDestination

)

Set destination path

Since: Series60 2.6

Parameters

const TDesC8 & aDestination

Destination path of the action (destination service).

SetError(TInt)

IMPORT_C void

SetError

(

TInt

aError

)

Sets error code

Since: Series S60 3.1

Parameters

TInt aError

SetLocal(TBool)

IMPORT_C void

SetLocal

(

TBool

aLocal

)

Sets the value of iLocal.

Since: Series60 2.6

Parameters

TBool aLocal

new value of the iLocal parameter

SetNameL(const TDesC8 &)

void

SetNameL

(

const TDesC8 &

aName

)

Parameters

const TDesC8 & aName

SetSender(const TInetAddr &)

IMPORT_C void

SetSender

(

const TInetAddr &

aSender

)

Set sender address

Since: Series60 2.6

Parameters

const TInetAddr & aSender

Source address of the action.

SetSessionId(TInt)

void

SetSessionId

(

TInt

aId

)

Parameters

TInt aId

Member Data Documentation

RPointerArray< CUpnpArgument > iArguments

RPointerArray< CUpnpArgument >

iArguments

[private]

TInetAddr iDestinationAddr

TInetAddr

iDestinationAddr

[private]

HBufC8 * iDestinationPath

HBufC8 *

iDestinationPath

[private]

TInt iError

TInt

iError

[private]

TInt iLocal

TInt

iLocal

[private]

HBufC8 * iName

HBufC8 *

iName

[private]

CUpnpService & iParentService

CUpnpService &

iParentService

[private]

TInetAddr iSender

TInetAddr

iSender

[private]

TInt iSessionId

TInt

iSessionId

[private]