Symbian^3 Product Developer Library >

CUPnPAbstractBrowsingSessionObserver Class Reference

class CUPnPAbstractBrowsingSessionObserver : public CBase

An abstract class for implementing a browsing session observer. This class is purposed as a base class for imnplementing a browsing observer. There are 2 main use cases: 1. reducing implementation code so that the actual observer will only need to write the observer methods that are really used. 2. implementing an observer proxy that will attach itself to a session and just handle some of the callbacks and forward a majority of the callbacks the original session observer.

upnpavcontrollerhelper.lib
Since
S60 3.2

Inherits from

  • CUPnPAbstractBrowsingSessionObserver
Public Member Functions
CUPnPAbstractBrowsingSessionObserver()
~CUPnPAbstractBrowsingSessionObserver()
voidBrowseResponse(const TDesC8 &, TInt, TInt, TInt, const TDesC8 &)
voidCreateContainerResponse(TInt, const TDesC8 &)
voidDeleteObjectResponse(TInt)
IMPORT_C voidDisableSessionObserver()
IMPORT_C voidEnableSessionObserver()
IMPORT_C TBoolIsSessionObserverEnabled()
voidMediaServerDisappeared(TUPnPDeviceDisconnectedReason)
voidReserveLocalMSServicesCompleted(TInt)
voidSearchCapabilitiesResponse(TInt, const TDesC8 &)
voidSearchResponse(const TDesC8 &, TInt, TInt, TInt, const TDesC8 &)
IMPORT_C voidSetSession(MUPnPAVBrowsingSession &)
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
MUPnPAVBrowsingSession *iObservedSession
TBool iObserverEnabled
MUPnPAVBrowsingSessionObserver *iProxyObserver

Constructor & Destructor Documentation

CUPnPAbstractBrowsingSessionObserver()

IMPORT_CCUPnPAbstractBrowsingSessionObserver()

default constructor.

~CUPnPAbstractBrowsingSessionObserver()

IMPORT_C~CUPnPAbstractBrowsingSessionObserver()[virtual]

destructor

Member Functions Documentation

BrowseResponse(const TDesC8 &, TInt, TInt, TInt, const TDesC8 &)

voidBrowseResponse(const TDesC8 &aBrowseResponse,
TIntaError,
TIntaMatches,
TIntaTotalCount,
const TDesC8 &aUpdateId
)

see MUPnPAVBrowsingSessionObserver

Parameters

const TDesC8 & aBrowseResponse
TInt aError
TInt aMatches
TInt aTotalCount
const TDesC8 & aUpdateId

CreateContainerResponse(TInt, const TDesC8 &)

voidCreateContainerResponse(TIntaError,
const TDesC8 &aObjectId
)

see MUPnPAVBrowsingSessionObserver

Parameters

TInt aError
const TDesC8 & aObjectId

DeleteObjectResponse(TInt)

voidDeleteObjectResponse(TIntaError)

see MUPnPAVBrowsingSessionObserver

Parameters

TInt aError

DisableSessionObserver()

IMPORT_C voidDisableSessionObserver()

Disables receiving session callbacks. The observer interface is deregistered, and if before observer registration there was an original observer interface (proxy mode) the original observer is restored.

Since
S60 3.2

EnableSessionObserver()

IMPORT_C voidEnableSessionObserver()

Enables receiving callbacks. When enabled, the abstract observer registers to the given session and thus starts receiving callbacks. Note that only those callbacks that are overwritten in the derived class will actually provide some value. Other will be either processed in an empty method, or forwarded to the observer that previously was registered as an observer (proxy mode)

Since
S60 3.2

IsSessionObserverEnabled()

IMPORT_C TBoolIsSessionObserverEnabled()

Returns true if the observer is active (registered for events)

Since
S60 3.2

MediaServerDisappeared(TUPnPDeviceDisconnectedReason)

voidMediaServerDisappeared(TUPnPDeviceDisconnectedReasonaReason)

see MUPnPAVBrowsingSessionObserver

Parameters

TUPnPDeviceDisconnectedReason aReason

ReserveLocalMSServicesCompleted(TInt)

voidReserveLocalMSServicesCompleted(TIntaError)

see MUPnPAVBrowsingSessionObserver

Parameters

TInt aError

SearchCapabilitiesResponse(TInt, const TDesC8 &)

voidSearchCapabilitiesResponse(TIntaError,
const TDesC8 &aSearchCapabilities
)

see MUPnPAVBrowsingSessionObserver

Parameters

TInt aError
const TDesC8 & aSearchCapabilities

SearchResponse(const TDesC8 &, TInt, TInt, TInt, const TDesC8 &)

voidSearchResponse(const TDesC8 &aSearchResponse,
TIntaError,
TIntaMatches,
TIntaTotalCount,
const TDesC8 &aUpdateId
)

see MUPnPAVBrowsingSessionObserver

Parameters

const TDesC8 & aSearchResponse
TInt aError
TInt aMatches
TInt aTotalCount
const TDesC8 & aUpdateId

SetSession(MUPnPAVBrowsingSession &)

IMPORT_C voidSetSession(MUPnPAVBrowsingSession &aHostSession)

Sets the host session for the observer. This is the session where the observer will register for callbacks. If the session already has an observer, it will become the proxy observer. The default implementatin for all observer methods is to forward the method to the observer, if it exists.

Since
S60 3.2

Parameters

MUPnPAVBrowsingSession & aHostSession

Member Data Documentation

MUPnPAVBrowsingSession * iObservedSession

MUPnPAVBrowsingSession *iObservedSession[private]

TBool iObserverEnabled

TBool iObserverEnabled[private]

MUPnPAVBrowsingSessionObserver * iProxyObserver

MUPnPAVBrowsingSessionObserver *iProxyObserver[private]

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.