NCBI C++ ToolKit
id1_client_.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id$
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file id1_client_.hpp
29 /// Data storage class.
30 ///
31 /// This file was generated by application DATATOOL
32 /// using the following specifications:
33 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/id1/id1.asn">id1.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/id1/id1.def">id1.def</a>
36 ///
37 /// ATTENTION:
38 /// Don't edit or commit this file into CVS as this file will
39 /// be overridden (by DATATOOL) without warning!
40 
41 #ifndef OBJECTS_ID1_ID1_CLIENT_BASE_HPP
42 #define OBJECTS_ID1_ID1_CLIENT_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
51 #include <serial/rpcbase.hpp>
52 
54 
55 #ifndef BEGIN_objects_SCOPE
56 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
57 # define END_objects_SCOPE END_SCOPE(objects)
58 #endif
59 BEGIN_objects_SCOPE // namespace ncbi::objects::
60 
61 
62 // forward declarations
63 class CID1Seq_hist;
64 class CSeq_id;
65 
66 
67 // generated classes
68 
69 
70 /** @addtogroup dataspec_NCBI_ID1Access
71  *
72  * @{
73  */
74 
75 /////////////////////////////////////////////////////////////////////////////
76 ///
77 /// CID1Client_Base --
78 ///
79 
80 class NCBI_ID1_EXPORT CID1Client_Base : public CRPCClient<CID1server_request, CID1server_back>
81 {
83 public:
84  // constructor
85  CID1Client_Base(void);
86  // destructor
87  virtual ~CID1Client_Base(void);
88 
93 
94  virtual void Ask(const TRequest& request, TReply& reply);
95  virtual void Ask(const TRequest& request, TReply& reply,
96  TReplyChoice::E_Choice wanted);
97 
98  virtual void AskInit
99  (TReply* reply = 0);
100 
101  virtual NCBI_NS_NCBI::TGi AskGetgi
102  (const CSeq_id& req, TReply* reply = 0);
103 
104  virtual CRef<CSeq_entry> AskGetsefromgi
105  (const CID1server_maxcomplex& req, TReply* reply = 0);
106 
107  virtual void AskFini
108  (TReply* reply = 0);
109 
110  virtual list< CRef< CSeq_id > > AskGetseqidsfromgi
111  (const NCBI_NS_NCBI::TGi& req, TReply* reply = 0);
112 
113  virtual list< CRef< CID1Seq_hist > > AskGetgihist
114  (const NCBI_NS_NCBI::TGi& req, TReply* reply = 0);
115 
116  virtual list< CRef< CID1Seq_hist > > AskGetgirev
117  (const NCBI_NS_NCBI::TGi& req, TReply* reply = 0);
118 
119  virtual int AskGetgistate
120  (const NCBI_NS_NCBI::TGi& req, TReply* reply = 0);
121 
122  virtual CRef<CID1SeqEntry_info> AskGetsewithinfo
123  (const CID1server_maxcomplex& req, TReply* reply = 0);
124 
125  virtual CRef<CID1blob_info> AskGetblobinfo
126  (const CID1server_maxcomplex& req, TReply* reply = 0);
127 
128 
129 protected:
130  void x_Connect(void);
131 
132  /// Disconnect as cleanly as possible.
133  ///
134  /// @note Derived classes that override this method
135  /// should copy the destructor logic that calls it (via
136  /// Disconnect, which avoids duplicate calls).
137  void x_Disconnect(void);
138 
139 private:
140  TReplyChoice& x_Choice(TReply& reply);
141 };
142 
143 /* @} */
144 
145 
146 
147 
148 
149 ///////////////////////////////////////////////////////////
150 ///////////////////// inline methods //////////////////////
151 ///////////////////////////////////////////////////////////
152 inline
154 {
155  return reply;
156 }
157 
158 inline
160 {
161  Tparent::Ask(request, reply);
162 }
163 
164 
165 ///////////////////////////////////////////////////////////
166 ////////////////// end of inline methods //////////////////
167 ///////////////////////////////////////////////////////////
168 
169 
170 
171 
172 
173 END_objects_SCOPE // namespace ncbi::objects::
174 
176 
177 
178 #endif // OBJECTS_ID1_ID1_CLIENT_BASE_HPP
User-defined methods of the data storage class.
CID1Client_Base –.
Definition: id1_client_.hpp:81
CID1Seq_hist –.
Definition: ID1Seq_hist.hpp:66
@ID1server_back.hpp User-defined methods of the data storage class.
CID1server_maxcomplex –.
CID1server_request –.
CRPCClient – prototype client for ASN.1/XML-based RPC.
Definition: rpcbase.hpp:63
CStrictId< SStrictId_Gi, SStrictId_Gi::TId > TGi
Definition: ncbimisc.hpp:1025
virtual void x_Disconnect(void)
Disconnect as cleanly as possible.
Definition: rpcbase.cpp:203
virtual void Ask(const TRequest &request, TReply &reply)
Definition: rpcbase.hpp:87
virtual void x_Connect(void) override
These run with m_Mutex already acquired.
Definition: rpcbase.hpp:199
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_ID1_EXPORT
Definition: ncbi_export.h:544
CID1server_request TRequest
Definition: id1_client_.hpp:89
CRPCClient< CID1server_request, CID1server_back > Tparent
Definition: id1_client_.hpp:82
TRequest TRequestChoice
Definition: id1_client_.hpp:91
TReplyChoice & x_Choice(TReply &reply)
virtual void Ask(const TRequest &request, TReply &reply)
E_Choice
Choice variants.
CID1server_back TReply
Definition: id1_client_.hpp:90
Modified on Sun Jun 23 05:16:10 2024 by modify_doxy.py rev. 669887