MLtsyDispatchFactoryV1 Class Reference

class MLtsyDispatchFactoryV1 : public MLtsyFactoryBase

This interface should be implemented by the Licensee LTSY and is used by the CTSY Dispatcher.

It allows the CTSY Dispatcher to retrieve handlers that are provided by the LTSY to handle rwequests made by the CTSY.

Inherits from

Member Functions Documentation

ConstructL(CCtsyDispatcherCallback &)

voidConstructL(CCtsyDispatcherCallback &aCallback)[pure virtual]

Complete construction of the interface. This function will be invokesd by the CTSY Dispatcher to allow the LTSY to create the various handler objects prior to any rquests being sent or received between the CTSY Dispatcher and LTSY.

Parameters

CCtsyDispatcherCallback & aCallback

GetDispatchHandler(TLtsyDispatchInterfaceApiId, TAny *&)

TInt GetDispatchHandler(TLtsyDispatchInterfaceApiIdaDispatchInterfaceId,
TAny *&aDispatchInterface
)[pure virtual]

Get a reference to a pointer to a specified dispatch handler interface.

This function should be implemented by the Licensee LTSY to enable the CTSY Dispatcher to retrieve a pointer to a specified dispatch handler. The dispatch handlers in the LTSY provide a functions that enable the CTSY Dispatcher to request that the LTSY service a request.

Parameters

TLtsyDispatchInterfaceApiId aDispatchInterfaceId
TAny *& aDispatchInterfaceWhen this function completes, will contain a reference to a pointer to the dispatch handler interface in the LTSY.

GetSatMessagingService(MCtsySatService &)

CTsySatMessagingBase *GetSatMessagingService(MCtsySatService &aSatMessagingService)[pure virtual]

This function should be implemented by the Licensee LTSY to load a SAT TSY.

Parameters

MCtsySatService & aSatMessagingServicerefenrence to CTSY side SAT services

IsCallbackIndicatorSupported(TInt, TLtsyDispatchIndIdGroup, TUint32 &)

voidIsCallbackIndicatorSupported(TIntaFuncUnitId,
TLtsyDispatchIndIdGroupaIdGroup,
TUint32 &aIndIdBitMask
)[pure virtual]

Query support in Licensee LTSY triggering the callback indicator APIs

This function should be implemented by the Licensee LTSY to enable the CTSY Dispatcher to query whether the Licensee LTSY supports a particular callback indicator. E.g. CCtsyDispatcherCallback::CallbackPhoneNotifyNitzInfoChangeInd. If a Licensee LTSY does not support receiving the event information from the baseband it will not be able to invoke the callback and should return false the query callback supported request.

If the Licensee LTSY does not support a particular callback it can result in some client notifier requests being completed with KErrNotSupported.

Example: IsCallbackIndicatorSupported(KDispatchCallControlFuncUnitId, EIndIdGroup1) should populate the aIndIdBitMask with a bit set for each indicator callback that is supported. So, 0x0 implies none supported, 0xFFFF implies every callback indicator supported.

Parameters

TInt aFuncUnitIdIdentifier to functional unit being queried
TLtsyDispatchIndIdGroup aIdGroupID of group that is being queried e.g. aIdGroup=EIndIdGroup1
TUint32 & aIndIdBitMask[out] argument that should return a bitmask indicating which indicator callbacks are supported.

IsDispatchInterfaceSupported(TInt, TLtsyDispatchInterfaceApiId)

TBool IsDispatchInterfaceSupported(TIntaFuncUnitId,
TLtsyDispatchInterfaceApiIdaDispatchApiId
)[pure virtual]

Query support for specific dispatch handler in Licensee LTSY

This function should be implemented by the Licensee LTSY to enable the CTSY Dispatcher to query whether the Licensee LTSY supports a particular dispatch handler e.g. MLtsyDispatchPhoneBootNotifyModemStatusReady.

Parameters

TInt aFuncUnitIdIdentifier to functional unit being queried
TLtsyDispatchInterfaceApiId aDispatchApiIdIdentifier to dispatch API handler being queried