InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICusDtLnkStateUpdateProcessor Class Referenceabstract

#include <ICusDtLnkStateUpdateProcessor.h>

Inheritance diagram for ICusDtLnkStateUpdateProcessor:
IPMUnknownCPMUnknown< ICusDtLnkStateUpdateProcessor >CusDtLnkStateUpdateProcessor

Public Types

enum  { kDefaultIID = IID_ICUSDTLNKSTATEUPDATEPROCESSOR }
 

Public Member Functions

virtual bool16 AddJob (const CusDtLnkLinkResourceStatePacket &job)=0
 
virtual bool16 RemoveJob (const CusDtLnkLinkResourceStatePacket &job)=0
 
virtual bool16 IsJobPending (const CusDtLnkLinkResourceStatePacket &job) const =0
 
virtual bool16 UpdateStateForJob (const CusDtLnkLinkResourceStatePacket &job)=0
 
virtual bool16 UpdateStateForTopJob ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract interface for CusDtLnk to maintain a queue for link status update job packets.

See Also
CusDtLnkLinkResourceStateUpdater
CusDtLnkLinkResourceStateUpdaterIdleTask

Member Function Documentation

virtual bool16 ICusDtLnkStateUpdateProcessor::AddJob (const CusDtLnkLinkResourceStatePacketjob)
pure virtual

Add a job to the processor

Parameters
job[IN] to be added to the queue.
Returns
kTrue if job is added successfully.

Implemented in CusDtLnkStateUpdateProcessor.

virtual bool16 ICusDtLnkStateUpdateProcessor::IsJobPending (const CusDtLnkLinkResourceStatePacketjob) const
pure virtual

Check if a job is already queued

Parameters
job[IN] to be checked.
Returns
kTrue if job is removed successfully.

Implemented in CusDtLnkStateUpdateProcessor.

virtual bool16 ICusDtLnkStateUpdateProcessor::RemoveJob (const CusDtLnkLinkResourceStatePacketjob)
pure virtual

Remove the job from the processor

Parameters
job[IN] to be removed from the queue.
Returns
kTrue if job is removed successfully.

Implemented in CusDtLnkStateUpdateProcessor.

virtual bool16 ICusDtLnkStateUpdateProcessor::UpdateStateForJob (const CusDtLnkLinkResourceStatePacketjob)
pure virtual

The state updater mainains a job queue. A job is to provide state update for a particular linkr resource. This routine process the state update function given a particular job packet, and remove it from the queue

Returns
kTrue if job is removed successfully.

Implemented in CusDtLnkStateUpdateProcessor.

virtual bool16 ICusDtLnkStateUpdateProcessor::UpdateStateForTopJob ()
pure virtual

Give a status update to the top job from the processor, and when job is updated and the link manager is informed, remove the job from job queue

Returns
kTrue if job is removed successfully.

Implemented in CusDtLnkStateUpdateProcessor.