rippled
AbstractClient.h
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2016 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #ifndef RIPPLE_TEST_ABSTRACTCLIENT_H_INCLUDED
21 #define RIPPLE_TEST_ABSTRACTCLIENT_H_INCLUDED
22 
23 #include <ripple/json/json_value.h>
24 
25 namespace ripple {
26 namespace test {
27 
28 /* Abstract Ripple Client interface.
29 
30  This abstracts the transport layer, allowing
31  commands to be submitted to a rippled server.
32 */
34 {
35 public:
36  virtual ~AbstractClient() = default;
37  AbstractClient() = default;
38  AbstractClient(AbstractClient const&) = delete;
40  operator=(AbstractClient const&) = delete;
41 
53  virtual Json::Value
54  invoke(std::string const& cmd, Json::Value const& params = {}) = 0;
55 
57  virtual unsigned
58  version() const = 0;
59 };
60 
61 } // namespace test
62 } // namespace ripple
63 
64 #endif
std::string
STL class.
ripple::test::AbstractClient
Definition: AbstractClient.h:33
ripple::test::AbstractClient::version
virtual unsigned version() const =0
Get RPC 1.0 or RPC 2.0.
ripple::test::AbstractClient::invoke
virtual Json::Value invoke(std::string const &cmd, Json::Value const &params={})=0
Submit a command synchronously.
ripple::test::AbstractClient::~AbstractClient
virtual ~AbstractClient()=default
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::test::AbstractClient::operator=
AbstractClient & operator=(AbstractClient const &)=delete
ripple::test::AbstractClient::AbstractClient
AbstractClient()=default
Json::Value
Represents a JSON value.
Definition: json_value.h:145