Symbian^3 Product Developer Library >

CUPnPFileSharingEngine Class Reference

class CUPnPFileSharingEngine : public CBase
File sharing engine class for UPnP Home Connect Application upnpapplicationengine.lib
Since
S60 3.1

Inherits from

  • CUPnPFileSharingEngine
Public Member Functions
~CUPnPFileSharingEngine()
IMPORT_C voidGetSelectionContentL(CDesCArray &)
IMPORT_C voidGetSelectionIndexesL(CArrayFix< TInt > &)
IMPORT_C CUPnPFileSharingEngine *NewL()
IMPORT_C CUPnPFileSharingEngine *NewLC()
IMPORT_C MUPnPFileSharingEngineObserver *Observer()
IMPORT_C voidRefreshSharedMediaL(THomeConnectMediaType)
IMPORT_C voidRequestSelectionContentL(THomeConnectMediaType)
IMPORT_C voidRequestSelectionIndexesL(THomeConnectMediaType)
IMPORT_C voidRequestSharingProgressL()
voidSetConMonStateL(TBool, TRequestStatus &)
IMPORT_C voidSetObserver(MUPnPFileSharingEngineObserver *)
IMPORT_C voidSetSelectionIndexesL(THomeConnectMediaType, const CArrayFix< TInt > &)
voidSetShareFileComplete(TBool)
IMPORT_C voidSetSharingStateL(TBool)
IMPORT_C voidShareMediaL(THomeConnectMediaType)
IMPORT_C TBoolSharingStateL()
IMPORT_C voidStartUploadListenerL()
IMPORT_C voidStopUploadListenerL()
Private Member Functions
CUPnPFileSharingEngine()
voidConnectionLost()
voidConstructL()
voidCopyCdescArrayL(const CDesCArray &, CDesCArray &)
voidCopyTintArrayL(const CArrayFix< TInt > &, CArrayFix< TInt > &)
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
CUPnPFileSharingEngineAO *iAO
CUPnPConnectionMonitor *iConnMon
CUpnpContentRequestAO *iContentRequestor
RUpnpContentServerClient iContentServer
CUpnpContentShareAO *iContentSharer
CArrayFixFlat< TInt > *iImageSelections
CArrayFixFlat< TInt > *iMusicSelections
MUPnPFileSharingEngineObserver *iObserver
CUpnpProgressWatcher *iProgress
TBool iShareFileState

Constructor & Destructor Documentation

CUPnPFileSharingEngine()

CUPnPFileSharingEngine()[private]

C++ default constructor.

~CUPnPFileSharingEngine()

IMPORT_C~CUPnPFileSharingEngine()[virtual]
Destructor.
Since
S60 3.1

Member Functions Documentation

ConnectionLost()

voidConnectionLost()[private]
Update the sharing state variable in case WLAN connection is lost From MUPnPConnectionMonitorObserver
Since
S60 3.1

ConstructL()

voidConstructL()[private]

By default Symbian 2nd phase constructor is private.

CopyCdescArrayL(const CDesCArray &, CDesCArray &)

voidCopyCdescArrayL(const CDesCArray &aSrc,
CDesCArray &aDst
)const [private]
Helper function to copy descriptors between arrays of CDesCArrays
Since
S60 3.1

Parameters

const CDesCArray & aSrc
CDesCArray & aDst

CopyTintArrayL(const CArrayFix< TInt > &, CArrayFix< TInt > &)

voidCopyTintArrayL(const CArrayFix< TInt > &aSrc,
CArrayFix< TInt > &aDst
)const [private]
Helper function to copy TInts between arrays of CArrayFix<TInt>&
Since
S60 3.1

Parameters

const CArrayFix< TInt > & aSrc
CArrayFix< TInt > & aDst

GetSelectionContentL(CDesCArray &)

IMPORT_C voidGetSelectionContentL(CDesCArray &aArray)const
Gets the album /playlist names from upnpcontentserver once ready
Since
S60 3.1

Parameters

CDesCArray & aArrayArray containng the names for the UI

GetSelectionIndexesL(CArrayFix< TInt > &)

IMPORT_C voidGetSelectionIndexesL(CArrayFix< TInt > &aMarkedItems)const
Gets the selected albums/playlist indexes
Since
S60 3.1

Parameters

CArrayFix< TInt > & aMarkedItemsThe indexes of the selections user has made\ relative to selections received from GetSelectionContentL

NewL()

IMPORT_C CUPnPFileSharingEngine *NewL()[static]
Two-phased constructor.
Since
S60 3.1

NewLC()

IMPORT_C CUPnPFileSharingEngine *NewLC()[static]
Two-phased constructor.
Since
S60 3.1

Observer()

IMPORT_C MUPnPFileSharingEngineObserver *Observer()
Return handle to MUPnPFileSharingEngineObserver interface
Since
S60 3.1

RefreshSharedMediaL(THomeConnectMediaType)

IMPORT_C voidRefreshSharedMediaL(THomeConnectMediaTypeaType)
Updates shared objects Asynchronous, callback to MUPnPFileSharingEngineObserver::HandleSharingDone and MUPnPFileSharingEngineObserver::HandleSharingProgress
Since
S60 3.1

Parameters

THomeConnectMediaType aTypeType of media to refresh

RequestSelectionContentL(THomeConnectMediaType)

IMPORT_C voidRequestSelectionContentL(THomeConnectMediaTypeaType)
Requests the album /playlist names Asynchronous, callback to MUPnPFileSharingEngineObserver::HandleSelectionContent
Since
S60 3.1

Parameters

THomeConnectMediaType aTypeType of the media requested

RequestSelectionIndexesL(THomeConnectMediaType)

IMPORT_C voidRequestSelectionIndexesL(THomeConnectMediaTypeaType)const
Gets the selected albums/playlist indexes Asynchronous, callback to MUPnPFileSharingEngineObserver::HandleSelectionIndexes
Since
S60 3.1

Parameters

THomeConnectMediaType aTypeType of media selected

RequestSharingProgressL()

IMPORT_C voidRequestSharingProgressL()
Request information about sharing statuses / progress from the contentserver. The information is received via callback
Since
S60 3.1

SetConMonStateL(TBool, TRequestStatus &)

voidSetConMonStateL(TBoolaState,
TRequestStatus &aStatus
)
Start or stop connection monitoring
Since
S60 3.1

Parameters

TBool aStateETrue = Start, EFalse = Stop
TRequestStatus & aStatusTRequestStatus for async operation

SetObserver(MUPnPFileSharingEngineObserver *)

IMPORT_C voidSetObserver(MUPnPFileSharingEngineObserver *aObserver)
Sets observer for active object
Since
S60 3.1

Parameters

MUPnPFileSharingEngineObserver * aObserver

SetSelectionIndexesL(THomeConnectMediaType, const CArrayFix< TInt > &)

IMPORT_C voidSetSelectionIndexesL(THomeConnectMediaTypeaType,
const CArrayFix< TInt > &aMarkedItems
)
Sets the user selections
Since
S60 3.1

Parameters

THomeConnectMediaType aTypeType of media selected
const CArrayFix< TInt > & aMarkedItemsThe indexes of the selections user has made\ relative to selections received from GetSelectionContentL

SetShareFileComplete(TBool)

voidSetShareFileComplete(TBoolaShareState)
Set share file completed flag
Since
S60 3.2.3

Parameters

TBool aShareStateset ETrue indicate imageandvideo or playlist shared completely, perhaps both of them shared completely. EFalse indicate imageandvideo or playlist shared incompletely, perhaps both of them shared completely.

SetSharingStateL(TBool)

IMPORT_C voidSetSharingStateL(TBoolaState)
Sets sharing state to on or off Asynchronous, callback to MUPnPFileSharingEngineObserver::HandleSharingStatus
Since
S60 3.1

Parameters

TBool aStateETrue to enable sharing, otherwise EFalse

ShareMediaL(THomeConnectMediaType)

IMPORT_C voidShareMediaL(THomeConnectMediaTypeaType)
Starts sharing process Asynchronous, callback to MUPnPFileSharingEngineObserver::HandleSharingDone and MUPnPFileSharingEngineObserver::HandleSharingProgress
Since
S60 3.1

Parameters

THomeConnectMediaType aType

SharingStateL()

IMPORT_C TBoolSharingStateL()
Gets file sharing state from local MediaServer
Since
S60 3.1

StartUploadListenerL()

IMPORT_C voidStartUploadListenerL()
Starts upload listener. Leave in case of error
Since
S60 3.1

StopUploadListenerL()

IMPORT_C voidStopUploadListenerL()
Stops upload listener. Leave in case of error
Since
S60 3.1

Member Data Documentation

CUPnPFileSharingEngineAO * iAO

CUPnPFileSharingEngineAO *iAO[private]

Active object for asynchronous file sharing

CUPnPConnectionMonitor * iConnMon

CUPnPConnectionMonitor *iConnMon[private]

Connection monitor

CUpnpContentRequestAO * iContentRequestor

CUpnpContentRequestAO *iContentRequestor[private]

Active object class retrieving information about selections and content from upnpcontentserver

RUpnpContentServerClient iContentServer

RUpnpContentServerClient iContentServer[private]

Client side handle to upnpcontentserver

CUpnpContentShareAO * iContentSharer

CUpnpContentShareAO *iContentSharer[private]

Active object for asynchronous get responce from content server Owned.

CArrayFixFlat< TInt > * iImageSelections

CArrayFixFlat< TInt > *iImageSelections[private]

Cached image selections

CArrayFixFlat< TInt > * iMusicSelections

CArrayFixFlat< TInt > *iMusicSelections[private]

Cached music selections

MUPnPFileSharingEngineObserver * iObserver

MUPnPFileSharingEngineObserver *iObserver[private]

Observer for file sharing state

CUpnpProgressWatcher * iProgress

CUpnpProgressWatcher *iProgress[private]

Active object handling querying progress

TBool iShareFileState

TBool iShareFileState[private]

Set share file completed flag.

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.