aboutsummaryrefslogtreecommitdiffstats
path: root/include/Types.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/Types.h')
-rw-r--r--include/Types.h24
1 files changed, 23 insertions, 1 deletions
diff --git a/include/Types.h b/include/Types.h
index fe6afed..9d55765 100644
--- a/include/Types.h
+++ b/include/Types.h
@@ -1,26 +1,48 @@
#pragma once
+/**
+ * @file Types.h
+ * @brief Shared enum types used by the runtime managers.
+ */
+
+/** @brief Runtime object categories known by the object manager. */
enum OBJECT_TYPE {
+ /** A database snapshot grouping relations and tuples. */
MULTIGROUP,
+ /** A relation object. */
RELATION,
+ /** A tuple object. */
TUPLE,
+ /** An attribute object. */
ATTRIBUTE,
+ /** A transaction object. */
TRANSACTION
};
+/** @brief Operations that may be supported by an object type. */
enum METHOD {
+ /** Opens an object and creates an authorized handle. */
OPEN,
+ /** Closes a previously opened handle. */
CLOSE,
- PARSE, // To plug a secondary namespace
+ /** Parses through a secondary namespace. */
+ PARSE,
+ /** Performs security checks. */
SECURITY
};
+/** @brief Claims granted to an authenticated connection. */
enum AUTH_CLAIM {
+ /** Permission to read object state. */
READ,
+ /** Permission to mutate object state. */
WRITE
};
+/** @brief Authentication strategies supported by the permissions layer. */
enum AUTH_METHOD {
+ /** Certificate-based authentication. */
CERTIFICATE,
+ /** Plain-text authentication. */
PLAIN_TEXT
};