Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
IceMX::MetricsAdminPrx Class Reference

The metrics administrative facet interface. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::MetricsAdminPrx:

Public Member Functions

 MetricsAdminPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
 MetricsAdminPrx (const MetricsAdminPrx &other) noexcept
 Copy constructor.
 MetricsAdminPrx (MetricsAdminPrx &&other) noexcept
 Move constructor.
void disableMetricsView (std::string_view name, const Ice::Context &context=Ice::noExplicitContext) const
 Disables a metrics view.
std::future< void > disableMetricsViewAsync (std::string_view name, const Ice::Context &context=Ice::noExplicitContext) const
 Disables a metrics view.
std::function< void()> disableMetricsViewAsync (std::string_view name, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Disables a metrics view.
void enableMetricsView (std::string_view name, const Ice::Context &context=Ice::noExplicitContext) const
 Enables a metrics view.
std::future< void > enableMetricsViewAsync (std::string_view name, const Ice::Context &context=Ice::noExplicitContext) const
 Enables a metrics view.
std::function< void()> enableMetricsViewAsync (std::string_view name, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Enables a metrics view.
MetricsFailuresSeq getMapMetricsFailures (std::string_view view, std::string_view map, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failures associated with the given view and map.
std::future< MetricsFailuresSeqgetMapMetricsFailuresAsync (std::string_view view, std::string_view map, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failures associated with the given view and map.
std::function< void()> getMapMetricsFailuresAsync (std::string_view view, std::string_view map, std::function< void(::IceMX::MetricsFailuresSeq)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failures associated with the given view and map.
MetricsFailures getMetricsFailures (std::string_view view, std::string_view map, std::string_view id, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failure associated for the given metrics.
std::future< MetricsFailuresgetMetricsFailuresAsync (std::string_view view, std::string_view map, std::string_view id, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failure associated for the given metrics.
std::function< void()> getMetricsFailuresAsync (std::string_view view, std::string_view map, std::string_view id, std::function< void(::IceMX::MetricsFailures)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics failure associated for the given metrics.
MetricsView getMetricsView (std::string_view view, std::int64_t &timestamp, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics objects for the given metrics view.
std::future< std::tuple< MetricsView, std::int64_t > > getMetricsViewAsync (std::string_view view, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics objects for the given metrics view.
std::function< void()> getMetricsViewAsync (std::string_view view, std::function< void(::IceMX::MetricsView, std::int64_t)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the metrics objects for the given metrics view.
::Ice::StringSeq getMetricsViewNames (::Ice::StringSeq &disabledViews, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the names of enabled and disabled metrics.
std::future< std::tuple<::Ice::StringSeq, ::Ice::StringSeq > > getMetricsViewNamesAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the names of enabled and disabled metrics.
std::function< void()> getMetricsViewNamesAsync (std::function< void(::Ice::StringSeq, ::Ice::StringSeq)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the names of enabled and disabled metrics.
MetricsAdminPrxoperator= (const MetricsAdminPrx &rhs) noexcept
 Copy assignment operator.
MetricsAdminPrxoperator= (MetricsAdminPrx &&rhs) noexcept
 Move assignment operator.
Public Member Functions inherited from Ice::Proxy< MetricsAdminPrx, Ice::ObjectPrx >
MetricsAdminPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
MetricsAdminPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
MetricsAdminPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
MetricsAdminPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
MetricsAdminPrx ice_compress (bool b) const
 Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
MetricsAdminPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
MetricsAdminPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
MetricsAdminPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
MetricsAdminPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
MetricsAdminPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
MetricsAdminPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
MetricsAdminPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
MetricsAdminPrx ice_fixed (ConnectionPtr connection) const
 Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
MetricsAdminPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
MetricsAdminPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
MetricsAdminPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
MetricsAdminPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
MetricsAdminPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
MetricsAdminPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const MetricsAdminPrx * operator-> () const noexcept
 The arrow operator.

Static Public Member Functions

static const char * ice_staticId () noexcept
 Gets the type ID of the associated Slice interface.

Detailed Description

The metrics administrative facet interface.

This interface allows remote administrative clients to access the metrics of an application that enabled the Ice administrative facility and configured one or more metrics views.

Definition at line 90 of file Metrics.h.


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