OXY-SYNC-DIRECTORY 1.0
OXY-SYNC-DIRECTORY Library Documentation
Loading...
Searching...
No Matches
oxy::directory Namespace Reference

The oxy::directory namespace contains interfaces and functions for synchronizing and updating the metadata directory. More...

Classes

struct  context_t
 Represents a context for database operations, encapsulating a connection and schema information. More...
struct  count_fn
 Function object for counting data in the database. More...
struct  enum_missing_fn
 Function object for enumerating missing entries. More...
struct  get_context_fn
 Function object for obtaining a context_t from a connection and schema. More...
struct  IConnection
 Interface for a connection to a Thrift service, supporting both pipe and socket connections. More...
 Interface for interacting with the metadata service. More...
struct  IPack
 Interface for interacting with the pack service. More...
struct  ISyncDirectory
 Interface for synchronizing the metadata directory. More...
struct  ITimeline
 Interface for interacting with the timeline service. More...
struct  IUpdateDirectory
 Interface for updating the metadata directory. More...
struct  pull_fn
 Function object for pulling data from the database. More...
struct  push_fn
 Function object for pushing data to the database. More...
struct  remove_all_fn
 Function object for removing all data from the database. More...
struct  remove_fn
 Function object for removing data from the database. More...
struct  reset_settings_fn
 Function object for resetting the configuration settings to default values. More...
struct  set_settings_fn
 Function object for setting the configuration settings from a file. More...
struct  ssl_context
 Represents the SSL context for secure connections, including CA, certificate, and key information. More...

Typedefs

using database_t = SQLite::Database
using IConnectionPtr = std::shared_ptr<IConnection>
using IMetadataPtr = std::shared_ptr<IMetadata>
 Represents a shared pointer to an IMetadata interface.
using IPackPtr = std::shared_ptr<IPack>
 Represents a shared pointer to an IPack interface.
using ISyncDirectoryPtr = std::shared_ptr<ISyncDirectory>
 Type alias for a shared pointer to an ISyncDirectory instance.
using ITimelinePtr = std::shared_ptr<ITimeline>
 Represents a shared pointer to an ITimeline interface.
using IUpdateDirectoryPtr = std::shared_ptr<IUpdateDirectory>
 Type alias for a shared pointer to an IUpdateDirectory instance.
using ProtocolPtr = std::shared_ptr<apache::thrift::protocol::TBinaryProtocol>
 Represents a pointer to a Thrift binary protocol.

Functions

OXY_DIRECTORY_API IConnectionPtr create_connection_instance ()
OXY_DIRECTORY_API IMetadataPtr create_metadata_instance ()
 Creates an instance of the IMetadata interface.
OXY_DIRECTORY_API IPackPtr create_pack_instance ()
 Creates an instance of the IPack interface.
OXY_DIRECTORY_API ISyncDirectoryPtr create_sync_instance ()
 Create an instance of ISyncDirectory.
OXY_DIRECTORY_API ITimelinePtr create_timeline_instance ()
 Creates an instance of the ITimeline interface.
OXY_DIRECTORY_API IUpdateDirectoryPtr create_update_instance ()
 Create an instance of IUpdateDirectory.

Variables

constexpr count_fn count
 A constexpr instance of the count_fn function object for use in functional programmin g.
constexpr enum_missing_fn enum_missing
 A constexpr instance of the enum_missing_fn function object for use in functional programming.
constexpr get_context_fn get_context
 A constexpr instance of the get_context_fn function object for use in functional programming.
constexpr pull_fn pull
 A constexpr instance of the pull_fn function object for use in functional programming.
constexpr push_fn push
 A constexpr instance of the push_fn function object for use in functional programmin g.
constexpr remove_fn remove
 A constexpr instance of the remove_fn function object for use in functional programming.
constexpr remove_all_fn remove_all
 A constexpr instance of the remove_all_fn function object for use in functional programming.
constexpr reset_settings_fn reset_settings
 A constexpr instance of the reset_settings_fn function object for use in functional programming.
constexpr set_settings_fn set_settings
 A constexpr instance of the set_settings_fn function object for use in functional programming.

Detailed Description

The oxy::directory namespace contains interfaces and functions for synchronizing and updating the metadata directory.

This namespace provides the ISyncDirectory and IUpdateDirectory interfaces, along with functions to create instances of these interfaces. The interfaces define methods for counting, synchronizing, and updating metadata records in the directory based on customer identifiers and metadata IDs.

Function Documentation

◆ create_sync_instance()

OXY_DIRECTORY_API ISyncDirectoryPtr oxy::directory::create_sync_instance ( )

Create an instance of ISyncDirectory.

Returns
A shared pointer to the created ISyncDirectory instance

◆ create_update_instance()

OXY_DIRECTORY_API IUpdateDirectoryPtr oxy::directory::create_update_instance ( )

Create an instance of IUpdateDirectory.

Returns
A shared pointer to the created IUpdateDirectory instance