diff options
| author | Marcos Magueta <maguetamarcos@gmail.com> | 2026-05-08 22:57:05 -0300 |
|---|---|---|
| committer | Marcos Magueta <maguetamarcos@gmail.com> | 2026-05-08 22:57:05 -0300 |
| commit | 0657d6815943b5350bf4a596cd826f7a9de14a90 (patch) | |
| tree | 53d4fbd03731e483f1bd83a58beab64a330c7f1d /include/Types.h | |
| parent | be67e04f498f02c601788f2e23913827d2aa3c21 (diff) | |
| download | RNT-0657d6815943b5350bf4a596cd826f7a9de14a90.tar.gz RNT-0657d6815943b5350bf4a596cd826f7a9de14a90.zip | |
port docs to doxygen
Diffstat (limited to 'include/Types.h')
| -rw-r--r-- | include/Types.h | 24 |
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 }; |
