59 lines
1.8 KiB
C++
59 lines
1.8 KiB
C++
#include <cstdarg>
|
|
#include <cstdint>
|
|
#include <cstdlib>
|
|
#include <ostream>
|
|
#include <new>
|
|
|
|
/// A replica represents an instance of a user's task data, providing an easy interface
|
|
/// for querying and modifying that data.
|
|
struct TCReplica;
|
|
|
|
/// TCUuid is used as a task identifier. Uuids do not contain any pointers and need not be freed.
|
|
struct TCUuid {
|
|
uint8_t bytes[16];
|
|
};
|
|
|
|
extern "C" {
|
|
|
|
extern const uintptr_t TC_UUID_STRING_BYTES;
|
|
|
|
/// Create a new TCReplica.
|
|
///
|
|
/// If path is NULL, then an in-memory replica is created. Otherwise, path is the path to the
|
|
/// on-disk storage for this replica. The path argument is no longer referenced after return.
|
|
///
|
|
/// Returns NULL on error; see tc_replica_error.
|
|
///
|
|
/// TCReplicas are not threadsafe.
|
|
TCReplica *tc_replica_new(const char *path);
|
|
|
|
/// Undo local operations until the most recent UndoPoint.
|
|
///
|
|
/// Returns -1 on error, 0 if there are no local operations to undo, and 1 if operations were
|
|
/// undone.
|
|
int32_t tc_replica_undo(TCReplica *rep);
|
|
|
|
/// Get the latest error for a replica, or NULL if the last operation succeeded.
|
|
///
|
|
/// The returned string is valid until the next replica operation.
|
|
const char *tc_replica_error(TCReplica *rep);
|
|
|
|
/// Free a TCReplica.
|
|
void tc_replica_free(TCReplica *rep);
|
|
|
|
/// Create a new, randomly-generated UUID.
|
|
TCUuid tc_uuid_new_v4();
|
|
|
|
/// Create a new UUID with the nil value.
|
|
TCUuid tc_uuid_nil();
|
|
|
|
/// Write the string representation of a TCUuid into the given buffer, which must be
|
|
/// at least TC_UUID_STRING_BYTES long. No NUL terminator is added.
|
|
void tc_uuid_to_str(TCUuid uuid, char *out);
|
|
|
|
/// Parse the given value as a UUID. The value must be exactly TC_UUID_STRING_BYTES long. Returns
|
|
/// false on failure.
|
|
bool tc_uuid_from_str(const char *val, TCUuid *out);
|
|
|
|
} // extern "C"
|