Search Toolkit Book for CPSG_ReplyItem
A self-containing part of the reply, e.g. a meta-data or a data blob. More...
#include <objtools/pubseq_gateway/client/psg_client.hpp>
Inheritance diagram for CPSG_ReplyItem:
Classes | |
| struct | SImpl |
Public Types | |
| enum | EType { eBlobData , eBlobInfo , eSkippedBlob , eBioseqInfo , eNamedAnnotInfo , ePublicComment , eProcessor , eIpgInfo , eNamedAnnotStatus , eEndOfReply } |
Public Member Functions | |
| 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_Reply > | GetReply () const |
| Get the reply that contains this item. More... | |
| const string & | GetProcessorId () |
| Get processor ID. More... | |
| virtual | ~CPSG_ReplyItem () |
Protected Member Functions | |
| CPSG_ReplyItem (EType type) | |
Private Attributes | |
| unique_ptr< SImpl > | m_Impl |
| shared_ptr< CPSG_Reply > | m_Reply |
| const EType | m_Type |
| string | m_ProcessorId |
Friends | |
| class | CPSG_Reply |
Detailed Description
A self-containing part of the reply, e.g. a meta-data or a data blob.
Definition at line 662 of file psg_client.hpp.
Member Enumeration Documentation
◆ EType
| enum CPSG_ReplyItem::EType | ( | void | ) |
| Enumerator | |
|---|---|
| eBlobData | |
| eBlobInfo | |
| eSkippedBlob | |
| eBioseqInfo | |
| eNamedAnnotInfo | |
| ePublicComment | |
| eProcessor | |
| eIpgInfo | |
| eNamedAnnotStatus | |
| eEndOfReply | No more items expected in the (overall!) reply. |
Definition at line 665 of file psg_client.hpp.
Constructor & Destructor Documentation
◆ ~CPSG_ReplyItem()
|
virtual |
Definition at line 1040 of file psg_client.cpp.
◆ CPSG_ReplyItem()
|
protected |
Definition at line 1044 of file psg_client.cpp.
Member Function Documentation
◆ GetNextMessage()
| SPSG_Message CPSG_ReplyItem::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.
- Parameters
-
min_severity Minimum severity level of messages to be retrieved.
Definition at line 1033 of file psg_client.cpp.
References assert, and CPSG_Queue::m_Impl.
◆ GetProcessorId()
◆ GetReply()
|
inline |
Get the reply that contains this item.
Definition at line 693 of file psg_client.hpp.
References m_Reply.
Referenced by CPSG_NamedAnnotStatus::GetId2AnnotStatusList(), and CPSG_BioseqInfo::GetOtherIds().
◆ GetStatus()
| EPSG_Status CPSG_ReplyItem::GetStatus | ( | CDeadline | deadline | ) | const |
Get the final result of this blob's retrieval.
If the blob retrieval is not finalized by the deadline, then "eInProgress" is returned.
Definition at line 1026 of file psg_client.cpp.
References assert, CPSG_Queue::m_Impl, and s_GetStatus().
◆ GetType()
|
inline |
Definition at line 678 of file psg_client.hpp.
References m_Type.
Friends And Related Function Documentation
◆ CPSG_Reply
|
friend |
Definition at line 710 of file psg_client.hpp.
Member Data Documentation
◆ m_Impl
|
private |
Definition at line 705 of file psg_client.hpp.
◆ m_ProcessorId
|
private |
Definition at line 708 of file psg_client.hpp.
Referenced by GetProcessorId().
◆ m_Reply
|
private |
Definition at line 706 of file psg_client.hpp.
Referenced by GetReply().
◆ m_Type
Definition at line 707 of file psg_client.hpp.
Referenced by GetType().
The documentation for this class was generated from the following files:
- include/objtools/pubseq_gateway/client/psg_client.hpp
- src/objtools/pubseq_gateway/client/psg_client.cpp
