RUpnpContentServerClient Class Reference

class RUpnpContentServerClient : public RSessionBase

RUpnpContentServerClient class is used to create session and a connection to UpnpContentServer

upnpcontentserverclient.lib
Since
S60 3.1

Inherits from

Public Member Functions
RUpnpContentServerClient ()
IMPORT_C void ChangeSharedContentL ( UpnpContentServer::TUpnpMediaType , const CArrayFix < TInt > &, TRequestStatus &)
IMPORT_C void Close ()
IMPORT_C void GetSelectionContentL ( UpnpContentServer::TUpnpMediaType , TRequestStatus &)
IMPORT_C void GetSelectionContentResultL ( CDesCArray &)
IMPORT_C void GetSelectionIndexesL ( UpnpContentServer::TUpnpMediaType , TRequestStatus &)
IMPORT_C void GetSelectionIndexesResultL ( CArrayFix < TInt > &)
IMPORT_C void OpenL ()
IMPORT_C void RefreshSharedContentL ( UpnpContentServer::TUpnpMediaType , TRequestStatus &)
IMPORT_C void StartConnectionMonitorL ( TInt , TRequestStatus &)
IMPORT_C void StartUploadListenerL ()
IMPORT_C void StopConnectionMonitorL ( TRequestStatus &)
IMPORT_C void StopUploadListenerL ()
Private Member Functions
void PrepareReceiveBuffersL ( TInt )
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
HBufC8 * iContentBuffer
TPtr8 iContentBufferPtr
HBufC8 * iReceiveBuffer
TPtr8 iReceiveBufferPtr
CBufFlat * iSendBuffer
TPtr8 iSendBufferPtr
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RUpnpContentServerClient()

IMPORT_C RUpnpContentServerClient ( )

C++ default constructor.

Member Functions Documentation

ChangeSharedContentL(UpnpContentServer::TUpnpMediaType, const CArrayFix< TInt > &, TRequestStatus &)

IMPORT_C void ChangeSharedContentL ( UpnpContentServer::TUpnpMediaType aType,
const CArrayFix < TInt > & aMarkedItems,
TRequestStatus & aStatus
)
Sends the selected indexes to server and starts sharing
Since
S60 3.2

Parameters

UpnpContentServer::TUpnpMediaType aType Type of media
const CArrayFix < TInt > & aMarkedItems List of selected indexes
TRequestStatus & aStatus TRequestStatus for async operation.

Close()

IMPORT_C void Close ( )
Closes the connection with Upnp Content Server
Since
S60 3.1

GetSelectionContentL(UpnpContentServer::TUpnpMediaType, TRequestStatus &)

IMPORT_C void GetSelectionContentL ( UpnpContentServer::TUpnpMediaType aType,
TRequestStatus & aStatus
)
Gets the names of existed albums/playlists
Since
S60 3.1

Parameters

UpnpContentServer::TUpnpMediaType aType Type of media
TRequestStatus & aStatus TRequestStatus for async operation

GetSelectionContentResultL(CDesCArray &)

IMPORT_C void GetSelectionContentResultL ( CDesCArray & aIDArray )
Ask the result of GetSelectionContentL call Should be used after the GetSelectionContentL has completed.
Since
S60 3.1

Parameters

CDesCArray & aIDArray Array to add selection items

GetSelectionIndexesL(UpnpContentServer::TUpnpMediaType, TRequestStatus &)

IMPORT_C void GetSelectionIndexesL ( UpnpContentServer::TUpnpMediaType aType,
TRequestStatus & aStatus
)
Gets the users previous selections as list of selected indexes
Since
S60 3.1

Parameters

UpnpContentServer::TUpnpMediaType aType Type of media
TRequestStatus & aStatus TRequestStatus for async operation.

GetSelectionIndexesResultL(CArrayFix< TInt > &)

IMPORT_C void GetSelectionIndexesResultL ( CArrayFix < TInt > & aMarkedItems )
Ask the result of GetSelectionIndexesL call
Since
S60 3.1

Parameters

CArrayFix < TInt > & aMarkedItems Array to hold the items

OpenL()

IMPORT_C void OpenL ( )
Creates new session to Upnp Content Server
Since
S60 3.1

PrepareReceiveBuffersL(TInt)

void PrepareReceiveBuffersL ( TInt aSize ) [private]
Free previous receive buffers and allocate new
Since
S60 3.1

Parameters

TInt aSize The size of the buffer

RefreshSharedContentL(UpnpContentServer::TUpnpMediaType, TRequestStatus &)

IMPORT_C void RefreshSharedContentL ( UpnpContentServer::TUpnpMediaType aType,
TRequestStatus & aStatus
)
Refresh the shared content
Since
S60 3.1

Parameters

UpnpContentServer::TUpnpMediaType aType Type of media
TRequestStatus & aStatus TRequestStatus for async operation.

StartConnectionMonitorL(TInt, TRequestStatus &)

IMPORT_C void StartConnectionMonitorL ( TInt aIapId,
TRequestStatus & aStatus
)
Start connection monitor in content server Handles stopping of media server in case of WLAN is lost
Since
S60 3.1

Parameters

TInt aIapId Access point id
TRequestStatus & aStatus TRequestStatus for async operation

StartUploadListenerL()

IMPORT_C void StartUploadListenerL ( )
Starts the media server upload listener Not supported
Since
S60 3.1

StopConnectionMonitorL(TRequestStatus &)

IMPORT_C void StopConnectionMonitorL ( TRequestStatus & aStatus )
Stop connection monitor in content server
Since
S60 3.1

Parameters

TRequestStatus & aStatus TRequestStatus for async operation

StopUploadListenerL()

IMPORT_C void StopUploadListenerL ( )
Stops the media server upload listener Not supported
Since
S60 3.1

Member Data Documentation

HBufC8 * iContentBuffer

HBufC8 * iContentBuffer [private]

Buffer for receiving content for sharing UI separate buffer because of multiple async requests Owned

TPtr8 iContentBufferPtr

TPtr8 iContentBufferPtr [private]

Buffer for receiving content for sharing UI separate buffer because of multiple async requests

HBufC8 * iReceiveBuffer

HBufC8 * iReceiveBuffer [private]

General buffer for receiving data Owned

TPtr8 iReceiveBufferPtr

TPtr8 iReceiveBufferPtr [private]

General buffer for receiving data

CBufFlat * iSendBuffer

CBufFlat * iSendBuffer [private]

General buffer for sending data Owned

TPtr8 iSendBufferPtr

TPtr8 iSendBufferPtr [private]

General buffer for sending data