NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
CPSG_Processor Class Reference

Search Toolkit Book for CPSG_Processor

Processor event. More...

#include <objtools/pubseq_gateway/client/psg_client.hpp>

+ Inheritance diagram for CPSG_Processor:
+ Collaboration diagram for CPSG_Processor:

Public Types

enum  EProgressStatus {
  eStart , eDone , eNotFound , eCanceled ,
  eTimeout , eError , eUnauthorized , eInProgress ,
  eUnknown
}
 
- Public Types inherited from CPSG_ReplyItem
enum  EType {
  eBlobData , eBlobInfo , eSkippedBlob , eBioseqInfo ,
  eNamedAnnotInfo , ePublicComment , eProcessor , eIpgInfo ,
  eNamedAnnotStatus , eEndOfReply
}
 

Public Member Functions

EProgressStatus GetProgressStatus () const
 Get progress status. More...
 
- Public Member Functions inherited from CPSG_ReplyItem
EType GetType () const
 
EPSG_Status GetStatus (CDeadline deadline) const
 Get the final result of this blob's retrieval. More...
 
SPSG_Message GetNextMessage (EDiagSev min_severity=eDiag_Error) const
 Unstructured text containing auxiliary info about the result – such as messages and errors that came from the PSG server or occured while trying to send request or to read and to process the reply. More...
 
shared_ptr< CPSG_ReplyGetReply () const
 Get the reply that contains this item. More...
 
const stringGetProcessorId ()
 Get processor ID. More...
 
virtual ~CPSG_ReplyItem ()
 

Private Member Functions

 CPSG_Processor (EProgressStatus progress_status)
 

Private Attributes

EProgressStatus m_ProgressStatus
 

Friends

class CPSG_Reply
 

Additional Inherited Members

- Protected Member Functions inherited from CPSG_ReplyItem
 CPSG_ReplyItem (EType type)
 

Detailed Description

Processor event.

Definition at line 1005 of file psg_client.hpp.

Member Enumeration Documentation

◆ EProgressStatus

Enumerator
eStart 
eDone 
eNotFound 
eCanceled 
eTimeout 
eError 
eUnauthorized 
eInProgress 
eUnknown 

Definition at line 1008 of file psg_client.hpp.

Constructor & Destructor Documentation

◆ CPSG_Processor()

CPSG_Processor::CPSG_Processor ( EProgressStatus  progress_status)
private

Definition at line 1359 of file psg_client.cpp.

Member Function Documentation

◆ GetProgressStatus()

EProgressStatus CPSG_Processor::GetProgressStatus ( ) const
inline

Get progress status.

Definition at line 1021 of file psg_client.hpp.

References m_ProgressStatus.

Friends And Related Function Documentation

◆ CPSG_Reply

friend class CPSG_Reply
friend

Definition at line 1028 of file psg_client.hpp.

Member Data Documentation

◆ m_ProgressStatus

EProgressStatus CPSG_Processor::m_ProgressStatus
private

Definition at line 1026 of file psg_client.hpp.

Referenced by GetProgressStatus().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:58:26 2024 by modify_doxy.py rev. 669887