userver: ugrpc::tests::ServiceFixtureBase Class Reference
Loading...
Searching...
No Matches
ugrpc::tests::ServiceFixtureBase Class Reference

#include <userver/ugrpc/tests/service_fixtures.hpp>

Detailed Description

See also
ugrpc::tests::ServiceBase

Definition at line 19 of file service_fixtures.hpp.

+ Inheritance diagram for ugrpc::tests::ServiceFixtureBase:

Protected Member Functions

utils::statistics::Snapshot GetStatistics (std::string prefix, std::vector< utils::statistics::Label > require_labels={})
 
void RegisterService (server::ServiceBase &service)
 
void RegisterService (server::GenericServiceBase &service)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void StartServer (client::ClientFactorySettings &&settings={})
 
void StopServer () noexcept
 
template<typename Client >
Client MakeClient ()
 
server::ServerGetServer () noexcept
 
void SetServerMiddlewares (server::Middlewares middlewares)
 Server middlewares can be modified before the first RegisterService call.
 
void SetClientMiddlewareFactories (client::MiddlewareFactories middleware_factories)
 Client middlewares can be modified before the first RegisterService call.
 
void ExtendDynamicConfig (const std::vector< dynamic_config::KeyValue > &)
 
dynamic_config::Source GetConfigSource () const
 
utils::statistics::StorageGetStatisticsStorage ()
 

Member Function Documentation

◆ ExtendDynamicConfig()

void ugrpc::tests::ServiceBase::ExtendDynamicConfig ( const std::vector< dynamic_config::KeyValue > & )
inherited

Modifies the internal dynamic configs storage. It is used by the server and clients, and is accessible through GetConfigSource. Initially, the configs are filled with compile-time defaults.

◆ GetConfigSource()

dynamic_config::Source ugrpc::tests::ServiceBase::GetConfigSource ( ) const
inherited
Returns
the dynamic configs affected by ExtendDynamicConfig.

◆ GetServer()

server::Server & ugrpc::tests::ServiceBase::GetServer ( )
noexceptinherited
Returns
the stored server::Server for advanced tweaking.

◆ GetStatistics()

utils::statistics::Snapshot ugrpc::tests::ServiceFixtureBase::GetStatistics ( std::string prefix,
std::vector< utils::statistics::Label > require_labels = {} )
protected
Returns
the statistics of the server and clients.

◆ GetStatisticsStorage()

utils::statistics::Storage & ugrpc::tests::ServiceBase::GetStatisticsStorage ( )
inherited
Returns
the statistics storage used by the server and clients.

◆ MakeClient()

template<typename Client >
Client ugrpc::tests::ServiceBase::MakeClient ( )
inlineinherited
Returns
a client for the specified gRPC service, connected to the server.

Definition at line 56 of file service.hpp.

◆ RegisterService()

void ugrpc::tests::ServiceBase::RegisterService ( server::ServiceBase & service)
inherited

Register a gRPC service implementation. The caller owns the service and should ensure that the services live at least until StopServer is called.

◆ StartServer()

void ugrpc::tests::ServiceBase::StartServer ( client::ClientFactorySettings && settings = {})
inherited

Starts the server and connects a grpc channel to it. Should be called after the services are registered.

◆ StopServer()

void ugrpc::tests::ServiceBase::StopServer ( )
noexceptinherited

Should be called before the registered services are destroyed. Should typically be called in the destructor of your gtest fixture.


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