Kinetic C/C++ Client
 All Classes Functions Variables Pages
blocking_kinetic_connection_interface.h
1 /*
2  * kinetic-cpp-client
3  * Copyright (C) 2014 Seagate Technology.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  */
20 
21 #ifndef BLOCKING_KINETIC_CONNECTION_INTERFACE_H_
22 #define BLOCKING_KINETIC_CONNECTION_INTERFACE_H_
23 
24 #include "kinetic/status.h"
25 #include "kinetic/kinetic_connection.h"
26 #include "kinetic/key_range_iterator.h"
27 #include "kinetic/common.h"
28 #include "kinetic/nonblocking_kinetic_connection.h"
29 #include <memory>
30 #include <string>
31 #include <vector>
32 
33 namespace kinetic {
34 
35 using std::shared_ptr;
36 using std::unique_ptr;
37 using std::string;
38 using std::vector;
39 
40 class KeyRangeIterator;
41 class BlockingCallbackState;
42 
43 
45  public:
47 
48  virtual void SetClientClusterVersion(int64_t cluster_version) = 0;
49 
50  virtual KineticStatus NoOp() = 0;
51  virtual KineticStatus Get(
52  const shared_ptr<const string> key,
53  unique_ptr<KineticRecord>& record) = 0;
54  virtual KineticStatus Get(const string& key, unique_ptr<KineticRecord>& record) = 0;
55  virtual KineticStatus GetNext(
56  const shared_ptr<const string> key,
57  unique_ptr<string>& actual_key,
58  unique_ptr<KineticRecord>& record) = 0;
59  virtual KineticStatus GetNext(
60  const string& key,
61  unique_ptr<string>& actual_key,
62  unique_ptr<KineticRecord>& record) = 0;
63  virtual KineticStatus GetPrevious(const shared_ptr<const string> key,
64  unique_ptr<string>& actual_key,
65  unique_ptr<KineticRecord>& record) = 0;
66  virtual KineticStatus GetPrevious(const string& key,
67  unique_ptr<string>& actual_key,
68  unique_ptr<KineticRecord>& record) = 0;
69  virtual KineticStatus GetVersion(const shared_ptr<const string> key,
70  unique_ptr<string>& version) = 0;
71  virtual KineticStatus GetVersion(const string& key, unique_ptr<string>& version) = 0;
72  virtual KineticStatus GetKeyRange(const shared_ptr<const string> start_key,
73  bool start_key_inclusive,
74  const shared_ptr<const string> end_key,
75  bool end_key_inclusive,
76  bool reverse_results,
77  int32_t max_results,
78  unique_ptr<vector<string>>& keys) = 0;
79  virtual KineticStatus GetKeyRange(const string& start_key,
80  bool start_key_inclusive,
81  const string& end_key,
82  bool end_key_inclusive,
83  bool reverse_results,
84  int32_t max_results,
85  unique_ptr<vector<string>>& keys) = 0;
86  virtual KeyRangeIterator IterateKeyRange(const shared_ptr<const string> start_key,
87  bool start_key_inclusive,
88  const shared_ptr<const string> end_key,
89  bool end_key_inclusive,
90  unsigned int frame_size) = 0;
91  virtual KeyRangeIterator IterateKeyRange(const string& start_key,
92  bool start_key_inclusive,
93  const string& end_key,
94  bool end_key_inclusive,
95  unsigned int frame_size) = 0;
96  virtual KineticStatus Put(const shared_ptr<const string> key,
97  const shared_ptr<const string> current_version, WriteMode mode,
98  const shared_ptr<const KineticRecord> record,
99  PersistMode persistMode) = 0;
100  virtual KineticStatus Put(const string& key,
101  const string& current_version, WriteMode mode,
102  const KineticRecord& record,
103  PersistMode persistMode) = 0;
104  virtual KineticStatus Put(const shared_ptr<const string> key,
105  const shared_ptr<const string> current_version, WriteMode mode,
106  const shared_ptr<const KineticRecord> record) = 0;
107  virtual KineticStatus Put(const string& key,
108  const string& current_version, WriteMode mode,
109  const KineticRecord& record) = 0;
110  virtual KineticStatus Delete(const shared_ptr<const string> key,
111  const shared_ptr<const string> version, WriteMode mode, PersistMode persistMode) = 0;
112  virtual KineticStatus Delete(const string& key, const string& version,
113  WriteMode mode, PersistMode persistMode) = 0;
114  virtual KineticStatus Delete(const shared_ptr<const string> key,
115  const shared_ptr<const string> version, WriteMode mode) = 0;
116  virtual KineticStatus Delete(const string& key, const string& version, WriteMode mode) = 0;
117  virtual KineticStatus GetLog(unique_ptr<DriveLog>& drive_log) = 0;
118  virtual KineticStatus GetLog(const vector<Command_GetLog_Type>& types, unique_ptr<DriveLog>& drive_log) = 0;
119  virtual KineticStatus P2PPush(const P2PPushRequest& push_request,
120  unique_ptr<vector<KineticStatus>>& operation_statuses) = 0;
121  virtual KineticStatus P2PPush(const shared_ptr<const P2PPushRequest> push_request,
122  unique_ptr<vector<KineticStatus>>& operation_statuses) = 0;
123 
124  virtual KineticStatus SetClusterVersion(int64_t cluster_version) = 0;
125  virtual KineticStatus UpdateFirmware(const shared_ptr<const string> new_firmware) = 0;
126  virtual KineticStatus SetACLs(const shared_ptr<const list<ACL>> acls) = 0;
127 
128  virtual KineticStatus SetErasePIN(const shared_ptr<const string> new_pin,
129  const shared_ptr<const string> current_pin = make_shared<string>()) = 0;
130  virtual KineticStatus SetErasePIN(const string& new_pin, const string& current_pin) = 0;
131  virtual KineticStatus SetLockPIN(const shared_ptr<const string> new_pin,
132  const shared_ptr<const string> current_pin = make_shared<string>()) = 0;
133  virtual KineticStatus SetLockPIN(const string& new_pin, const string& current_pin) = 0;
134  virtual KineticStatus InstantErase(const shared_ptr<string> pin) = 0;
135  virtual KineticStatus InstantErase(const string& pin) = 0;
136  virtual KineticStatus SecureErase(const shared_ptr<string> pin) = 0;
137  virtual KineticStatus SecureErase(const string& pin) = 0;
138  virtual KineticStatus LockDevice(const shared_ptr<string> pin) = 0;
139  virtual KineticStatus LockDevice(const string& pin) = 0;
140  virtual KineticStatus UnlockDevice(const shared_ptr<string> pin) = 0;
141  virtual KineticStatus UnlockDevice(const string& pin) = 0;
142 
143 };
144 
145 } // namespace kinetic
146 
147 
148 
149 #endif /* BLOCKING_KINETIC_CONNECTION_INTERFACE_H_ */
Represents a collection of P2P operations.
Indicates whether a Kinetic operation (get, put, security, etc) put succeeded or failed. Unlike Status it provides details like whether the failure resulted from a version or an HMAC error.
Encapsulates a single value stored in a Kinetic drive and the associated metadata.