Welcome to the OXY-SYNC-CONTAINER library user manual.

This documentation is intended to help developers and integrators quickly understand, use, and extend the libraries. It provides a guided overview of the project, core concepts, public APIs, and practical usage patterns.

Use this manual to:

learn the purpose and design goals of the project,
find usage examples and recommended integration approaches,
understand module boundaries and key abstractions,
navigate reference material for classes, functions, and data structures.

Concepts and Architecture

OXY is a version control distributed data storage container management framework. Version control is a way to save changes over time without overwriting previous versions. Being distributed means that every application working with a OXY container has a copy of that entire container, including all of its history.

OXY is organized into four main components:

OXY-API: A library that provides a high-level and low-level interface for interacting with containers, including version control operations, data storage, and container management.
OXY-SYNC-CONTAINER: Plugin library that provides a synchronization mechanism for containers, allowing multiple applications to work with the same container simultaneously.
OXY-SYNC-DIRECTORY: Plugin library that provides a synchronization mechanism for container metadata, allowing multiple applications to work with the same metadata simultaneously.
OXY-AUTHENTICATION: Plugin library that provides authentication mechanisms for synchronization, ensuring that only authenticated users can perform synchronization operations.

OXY-SYNC-CONTAINER is a plugin library that provides a synchronization mechanism for containers, allowing multiple applications to work with the same container simultaneously.

All synchronization operations on containers, such as merging changes, resolving conflicts, and synchronizing data between different instances of a container, are performed through the OXY-SYNC-CONTAINER library.

All functionalities in the OXY-SYNC-CONTAINER are grouped under the oxy::sync namespace, which provides a clear separation between the OXY-SYNC-CONTAINER and other libraries.