ImagingTools Core SDK
Public Member Functions | List of all members
imtbase::IProgressSessionsManagerabstract

#include <IProgressSessionsManager.h>

Inherits istd::IPolymorphic.

Inherited by imtservergql::CProgressManagerPublisherComp [virtual].

Public Member Functions

virtual ibase::IProgressManager * BeginProgressSession (const QByteArray &sessionId, const QString &description)=0
 
virtual bool EndProgressSession (const QByteArray &sessionId)=0
 
virtual bool CancelProgressSession (const QByteArray &sessionId, const QString &description=QString(), bool isFailed=false)=0
 

Detailed Description

Common interface for managing progress sessions

Definition at line 16 of file IProgressSessionsManager.h.

Member Function Documentation

◆ BeginProgressSession()

virtual ibase::IProgressManager * imtbase::IProgressSessionsManager::BeginProgressSession ( const QByteArray &  sessionId,
const QString &  description 
)
pure virtual

Create a progress manager session and return a pointer to it The pointer remains valid until EndProgressSession or CancelProgressSession is called with given session ID

◆ CancelProgressSession()

virtual bool imtbase::IProgressSessionsManager::CancelProgressSession ( const QByteArray &  sessionId,
const QString &  description = QString(),
bool  isFailed = false 
)
pure virtual

Cancel progress session with given ID

◆ EndProgressSession()

virtual bool imtbase::IProgressSessionsManager::EndProgressSession ( const QByteArray &  sessionId)
pure virtual

End progress session with given ID normally