Collapse all Symbian^3 Product Developer Library

CUpnpCommand Class Reference

class CUpnpCommand : public CBase

UpnpCommand ECom plugin interface definition.

Inherits from

CUpnpCommand
- CBase

Public Member Functions
	~CUpnpCommand()
void	AllocateResourcesL()
TInt32	DtorKeyOffset()
void	ExecuteL()
const TDesC &	File(TInt)
TInt	FileCount()
TBool	IsAvailableL()
TBool	IsAvailableL(UpnpCommand::TUpnpCommandId)
const TDesC &	Parameter(UpnpCommand::TUpnpParameterType)
void	PushFileL(const TDesC &)
void	ReleaseResources()
void	ResetFiles()
void	ResetParameters()
void	SetCommandIdL(UpnpCommand::TUpnpCommandId)
void	SetObserver(MUpnpCommandCallback *)
void	SetParameterL(UpnpCommand::TUpnpParameterType, const TDesC &)
UpnpCommand::TUpnpCommandState	State()

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
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CUpnpCommand()

~CUpnpCommand

(

)

[inline, virtual]

Destructor.

Member Functions Documentation

AllocateResourcesL()

void

AllocateResourcesL

(

)

[pure virtual]

Allocates the Upnp Framework resources.

DtorKeyOffset()

TInt32

DtorKeyOffset

(

)

[static, inline]

the DtorKey offset to pass in REComSession::CreateImplementationL

ExecuteL()

void

ExecuteL

(

)

[pure virtual]

Executes the command. If Upnp Framework resources are not yet allocated, they are allocated.

File(TInt)

const TDesC &

File

(

TInt

aIndex

)

[pure virtual]

Returns a file in the file pipe

Parameters

TInt aIndex

index of the file in pipe

FileCount()

TInt

FileCount

(

)

[pure virtual]

number of files in the file pipe

IsAvailableL()

TBool

IsAvailableL

(

)

[pure virtual]

Checks if this command is available for execution.

IsAvailableL(UpnpCommand::TUpnpCommandId)

TBool

IsAvailableL

(

UpnpCommand::TUpnpCommandId

aCommandId

)

[pure virtual]

Checks if given command is available for execution.

Parameters

UpnpCommand::TUpnpCommandId aCommandId

(UpnpCommand::TUpnpCommandId) the command ID

Parameter(UpnpCommand::TUpnpParameterType)

const TDesC &

Parameter

(

UpnpCommand::TUpnpParameterType

aParamType

)

[pure virtual]

Returns a parameter, either set by client or returned as an out parameter after command execution

Parameters

UpnpCommand::TUpnpParameterType aParamType

(UpnpCommand::TUpnpParameterType)

PushFileL(const TDesC &)

void

PushFileL

(

const TDesC &

aParam

)

[pure virtual]

Pushes one file into the file pipe.

Parameters

const TDesC & aParam

ReleaseResources()

void

ReleaseResources

(

)

[pure virtual]

Releases the Upnp Framework resources. Stops command execution if it is ongoing.

ResetFiles()

void

ResetFiles

(

)

[pure virtual]

Resets files in the file pipe

ResetParameters()

void

ResetParameters

(

)

[pure virtual]

Resets all parameter values

SetCommandIdL(UpnpCommand::TUpnpCommandId)

void

SetCommandIdL

(

UpnpCommand::TUpnpCommandId

aCommandId

)

[pure virtual]

Sets the command identity.

Parameters

UpnpCommand::TUpnpCommandId aCommandId

(UpnpCommand::TUpnpCommandId) the command ID

SetObserver(MUpnpCommandCallback *)

void

SetObserver

(

MUpnpCommandCallback *

aCallback

)

[pure virtual]

Sets the observer.

Parameters

MUpnpCommandCallback * aCallback

The callback interface

SetParameterL(UpnpCommand::TUpnpParameterType, const TDesC &)

void	SetParameterL	(	UpnpCommand::TUpnpParameterType	aParamType,
			const TDesC &	aParamValue
		)	[pure virtual]

Sets a parameter.

Leaves if the given param type or value is not valid.

Parameters

UpnpCommand::TUpnpParameterType aParamType	parameter category
const TDesC & aParamValue	(const TDesC&) parameter value

State()

UpnpCommand::TUpnpCommandState

State

(

)

[pure virtual]

Returns the state of the command

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

ECom instance identifier key.