CUpnpFileTransferEvent Class Reference

class CUpnpFileTransferEvent : public CUpnpMediaServerEvent

Class encapsulates file transfer message

MediaServerClient.lib
Since
S60 v3.1

Inherits from

Public Member Functions
~CUpnpFileTransferEvent ()
IMPORT_C CUpnpFileTransferEvent * CloneL ()
IMPORT_C TInt ContentDirectoryObjectId ()
IMPORT_C TDirection Direction ()
IMPORT_C TInt ErrorCode ()
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C TDesC & FilePath ()
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C CUpnpFileTransferEvent * NewL ()
IMPORT_C CUpnpFileTransferEvent * NewLC ()
IMPORT_C TProgressState ProgressState ()
IMPORT_C void SetContentDirectoryObjectId ( TInt )
IMPORT_C void SetDirection ( TDirection )
IMPORT_C void SetErrorCode ( TInt )
IMPORT_C void SetFilePathL (const TDesC &)
IMPORT_C void SetProgressState ( TProgressState )
IMPORT_C void SetTransferId ( TInt )
IMPORT_C TInt TransferId ()
Private Member Functions
CUpnpFileTransferEvent ()
void ConstructL ()
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()
CUpnpMediaServerEvent::CUpnpMediaServerEvent(TInt)
CUpnpMediaServerEvent::GetEventType()
CUpnpMediaServerEvent::~CUpnpMediaServerEvent()
Public Member Enumerations
enum TDirection { EIncoming , EOutgoing }
enum TProgressState { EStarted , ECompleted , EFailed , EStopped }
Private Attributes
TInt iContentDirectoryObjectId
TInt iDirection
TInt iErrorCode
HBufC * iFilePath
TInt iProgress
TInt iTransferId
Inherited Attributes
CUpnpMediaServerEvent::iEventType

Constructor & Destructor Documentation

CUpnpFileTransferEvent()

CUpnpFileTransferEvent ( ) [private]

Constructor.

~CUpnpFileTransferEvent()

~CUpnpFileTransferEvent ( ) [virtual]

Destructor.

Member Functions Documentation

CloneL()

IMPORT_C CUpnpFileTransferEvent * CloneL ( )
Sets error code
Since
Series 60 3.1

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

ContentDirectoryObjectId()

IMPORT_C TInt ContentDirectoryObjectId ( )
Gets content directory object identifier associated with transfer
Since
Series 60 3.1

Direction()

IMPORT_C TDirection Direction ( )
Gets transfer direction
Since
Series 60 3.1

ErrorCode()

IMPORT_C TInt ErrorCode ( )
Gets error code
Since
Series 60 3.1

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const [virtual]
Externalizes transfer event information to a stream. Leaves in case of errors.
Since
Series 60 3.1

Parameters

RWriteStream & aStream

FilePath()

IMPORT_C TDesC & FilePath ( )
Gets file path
Since
Series 60 3.1

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream ) [virtual]
Internalizes transfer event information from a stream. Leaves in case of errors.
Since
Series 60 3.1

Parameters

RReadStream & aStream

NewL()

IMPORT_C CUpnpFileTransferEvent * NewL ( ) [static]

Two-phased constructor.

NewLC()

IMPORT_C CUpnpFileTransferEvent * NewLC ( ) [static]

Two-phased constructor.

ProgressState()

IMPORT_C TProgressState ProgressState ( )
Gets progress state of transfer
Since
Series 60 3.1

SetContentDirectoryObjectId(TInt)

IMPORT_C void SetContentDirectoryObjectId ( TInt aObjectId )
Sets content directory object identifier associated with transfer
Since
Series 60 3.1

Parameters

TInt aObjectId object identifier

SetDirection(TDirection)

IMPORT_C void SetDirection ( TDirection aState )
Sets transfer direction
Since
Series 60 3.1

Parameters

TDirection aState progress state

SetErrorCode(TInt)

IMPORT_C void SetErrorCode ( TInt aError )
Sets error code
Since
Series 60 3.1

Parameters

TInt aError transport specific error code

SetFilePathL(const TDesC &)

IMPORT_C void SetFilePathL ( const TDesC & aFile )
Gets file path
Since
Series 60 3.1

Parameters

const TDesC & aFile file path

SetProgressState(TProgressState)

IMPORT_C void SetProgressState ( TProgressState aState )
Sets progress state of transfer
Since
Series 60 3.1

Parameters

TProgressState aState progress state

SetTransferId(TInt)

IMPORT_C void SetTransferId ( TInt aTransferId )
Sets transfer identifier
Since
Series 60 3.1

Parameters

TInt aTransferId transfer identifier

TransferId()

IMPORT_C TInt TransferId ( )
Gets content transfer identifier
Since
Series 60 3.1

Member Enumerations Documentation

Enum TDirection

Enumerators

EIncoming
EOutgoing

Enum TProgressState

Enumerators

EStarted
ECompleted
EFailed
EStopped

Member Data Documentation

TInt iContentDirectoryObjectId

TInt iContentDirectoryObjectId [private]

TInt iDirection

TInt iDirection [private]

TInt iErrorCode

TInt iErrorCode [private]

HBufC * iFilePath

HBufC * iFilePath [private]

TInt iProgress

TInt iProgress [private]

TInt iTransferId

TInt iTransferId [private]