OXY-SYNC-CONTAINER 1.0
OXY-SYNC-CONTAINER Library Documentation
Loading...
Searching...
No Matches
oxy::sync::api::ISyncContainer Struct Referenceabstract

Interface for sync container operations. More...

#include <api.hpp>

Public Member Functions

virtual ~ISyncContainer ()=default
 Virtual destructor for the interface.
virtual void clone (oid_t const &container, std::string const &identifier)=0
 Clone a container with a given customer identifier.
virtual void fetch (connection_ptr const &conn, std::string const &identifier)=0
 Fetch data from a connection with a given customer identifier.
virtual oids merge (connection_ptr const &conn, signature_t const &author)=0
 Merge data from a connection with a given author signature.
virtual void push (connection_ptr const &conn, signature_t const &author, std::string const &identifier)=0
 Push data to a connection with a given author signature and identifier.

Detailed Description

Interface for sync container operations.

This interface defines methods for cloning, fetching, merging, and pushing data in a sync container.

Member Function Documentation

◆ clone()

virtual void oxy::sync::api::ISyncContainer::clone ( oid_t const & container,
std::string const & identifier )
pure virtual

Clone a container with a given customer identifier.

Parameters
container- The identifier of the container to clone.
identifier- The customer identifier to use for the operation.

◆ fetch()

virtual void oxy::sync::api::ISyncContainer::fetch ( connection_ptr const & conn,
std::string const & identifier )
pure virtual

Fetch data from a connection with a given customer identifier.

Parameters
conn- The connection pointer to use for the operation.
identifier- The customer identifier to use for the operation.

◆ merge()

virtual oids oxy::sync::api::ISyncContainer::merge ( connection_ptr const & conn,
signature_t const & author )
pure virtual

Merge data from a connection with a given author signature.

Parameters
conn- The connection pointer to use for the operation.
author- The author signature to use for the operation.

◆ push()

virtual void oxy::sync::api::ISyncContainer::push ( connection_ptr const & conn,
signature_t const & author,
std::string const & identifier )
pure virtual

Push data to a connection with a given author signature and identifier.

Parameters
conn- The connection pointer to use for the operation.
author- The author signature to use for the operation.
identifier- The customer identifier to use for the operation.