diff options
Diffstat (limited to 'zenserver')
| -rw-r--r-- | zenserver/cache/structuredcache.h | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/zenserver/cache/structuredcache.h b/zenserver/cache/structuredcache.h index d0646e6e9..e2ab60928 100644 --- a/zenserver/cache/structuredcache.h +++ b/zenserver/cache/structuredcache.h @@ -12,6 +12,29 @@ namespace zen { /** * New-style cache service. Imposes constraints on keys, supports blobs and * structured values + * + * Keys are structured as: + * + * {BucketId}/{KeyHash} + * + * Where BucketId is an alphanumeric string, and KeyHash is a 40-character hexadecimal + * sequence. The hash value may be derived in any number of ways, it's up to the + * application to pick an approach. + * + * Values may be structured or unstructured. Structured values are encoded using Unreal + * Engine's compact binary encoding + * + * Additionally, attachments may be addressed as: + * + * {BucketId}/{KeyHash}/{PayloadHash} + * + * Where the two initial components are the same as for the main endpoint + * + * The storage strategy is as follows: + * + * - Structured values are stored in a dedicated backing store per bucket + * - Unstructured values and attachments are stored in the CAS pool + * */ class HttpStructuredCacheService : public zen::HttpService |