Skip to content

Commit

Permalink
Exclude testing callbacks from client library public API
Browse files Browse the repository at this point in the history
I don't think there's much value in backwards compatibility for these,
and they rely on some of LogCabin's internals.

Towards logcabin#99: versioning
  • Loading branch information
ongardie authored and Nate Hardt committed Aug 20, 2015
1 parent 5db9c58 commit 1d2768c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
9 changes: 7 additions & 2 deletions include/LogCabin/Client.h
Expand Up @@ -512,6 +512,8 @@ class Tree {
* When running in testing mode, these callbacks serve as a way for the
* application to interpose on requests and responses to inject failures and
* model dynamic scenarios. See Cluster's constructor for more information.
*
* This is experimental and is not part of LogCabin's public API.
*/
class TestingCallbacks {
public:
Expand Down Expand Up @@ -588,13 +590,16 @@ class Cluster {
* Construct a Cluster object for testing purposes only. Instead of
* connecting to a LogCabin cluster, it will keep all state locally in
* memory.
*
* This is experimental and is not part of LogCabin's public API.
*
* \param testingCallbacks
* These allow the application to interpose on requests. A
* default-constructed TestingCallbacks will execute requests against
* an in-memory structure. Applications can pass in classes derived
* from TestingCallbacks to model failures and more dynamic scenarios.
* \param options
* Settings for the client library.
* Settings for the client library (see #Options).
*/
explicit Cluster(std::shared_ptr<TestingCallbacks> testingCallbacks,
const Options& options = Options());
Expand All @@ -607,7 +612,7 @@ class Cluster {
* multiple IP addresses. Alternatively, you can pass a list of hosts
* as host1:port1,host2:port2,host3:port3.
* \param options
* Settings for the client library.
* Settings for the client library (see #Options).
*/
explicit Cluster(const std::string& hosts,
const Options& options = Options());
Expand Down
8 changes: 8 additions & 0 deletions include/LogCabin/Debug.h
Expand Up @@ -14,6 +14,14 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/**
* \file
* This file is used to control how LogCabin's debug log (event log) messages
* are handled. When used by client applications, this should be accessed as
* LogCabin::Client::Debug (the LogCabin::Core namespace is used internally in
* LogCabin).
*/

#include <cstdio>
#include <initializer_list>
#include <functional>
Expand Down

0 comments on commit 1d2768c

Please sign in to comment.