userver: storages::secdist::Secdist Class Reference
No Matches
storages::secdist::Secdist Class Referencefinal

#include <userver/storages/secdist/secdist.hpp>

Detailed Description

Client to retrieve credentials from the components::Secdist and to subscribe to their updates.

Definition at line 116 of file secdist.hpp.

Public Member Functions

 Secdist (SecdistConfig::Settings settings)
const storages::secdist::SecdistConfigGet () const
rcu::ReadablePtr< storages::secdist::SecdistConfigGetSnapshot () const
template<typename Class >
concurrent::AsyncEventSubscriberScope UpdateAndListen (Class *obj, std::string_view name, void(Class::*func)(const storages::secdist::SecdistConfig &secdist))
bool IsPeriodicUpdateEnabled () const

Member Function Documentation

◆ Get()

const storages::secdist::SecdistConfig & storages::secdist::Secdist::Get ( ) const

Returns secdist data loaded on service start. Does not support secdist updating during service work.

◆ GetSnapshot()

rcu::ReadablePtr< storages::secdist::SecdistConfig > storages::secdist::Secdist::GetSnapshot ( ) const

Returns fresh secdist data (from last update). Supports secdist updating during service work.

◆ UpdateAndListen()

template<typename Class >
concurrent::AsyncEventSubscriberScope storages::secdist::Secdist::UpdateAndListen ( Class * obj,
std::string_view name,
void(Class::*)(const storages::secdist::SecdistConfig &secdist) func )

Subscribes to secdist updates using a member function, named OnSecdistUpdate by convention. Also immediately invokes the function with the current secdist data.

Definition at line 151 of file secdist.hpp.

The documentation for this class was generated from the following file: