IceMX::MetricsAdminPrx Class Reference

The metrics administrative facet interface. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::MetricsAdminPrx:

Collaboration diagram for IceMX::MetricsAdminPrx:

Public Member Functions
void	disableMetricsView (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
	Disable a metrics view. More...
::std::function< void()>	disableMetricsViewAsync (const ::std::string &name, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Disable a metrics view. More...
template<template< typename > class P = ::std::promise>
auto	disableMetricsViewAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Disable a metrics view. More...
void	enableMetricsView (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext)
	Enables a metrics view. More...
::std::function< void()>	enableMetricsViewAsync (const ::std::string &name, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Enables a metrics view. More...
template<template< typename > class P = ::std::promise>
auto	enableMetricsViewAsync (const ::std::string &name, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Enables a metrics view. More...
MetricsFailuresSeq	getMapMetricsFailures (const ::std::string &view, const ::std::string &map, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics failures associated with the given view and map. More...
::std::function< void()>	getMapMetricsFailuresAsync (const ::std::string &view, const ::std::string &map, ::std::function< void(::IceMX::MetricsFailuresSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics failures associated with the given view and map. More...
template<template< typename > class P = ::std::promise>
auto	getMapMetricsFailuresAsync (const ::std::string &view, const ::std::string &map, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceMX::MetricsFailuresSeq >>().get_future())
	Get the metrics failures associated with the given view and map. More...
MetricsFailures	getMetricsFailures (const ::std::string &view, const ::std::string &map, const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics failure associated for the given metrics. More...
::std::function< void()>	getMetricsFailuresAsync (const ::std::string &view, const ::std::string &map, const ::std::string &id, ::std::function< void(::IceMX::MetricsFailures)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics failure associated for the given metrics. More...
template<template< typename > class P = ::std::promise>
auto	getMetricsFailuresAsync (const ::std::string &view, const ::std::string &map, const ::std::string &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::IceMX::MetricsFailures >>().get_future())
	Get the metrics failure associated for the given metrics. More...
MetricsView	getMetricsView (const ::std::string &view, long long int &timestamp, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics objects for the given metrics view. More...
::std::function< void()>	getMetricsViewAsync (const ::std::string &view, ::std::function< void(::IceMX::MetricsView, long long int)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the metrics objects for the given metrics view. More...
template<template< typename > class P = ::std::promise>
auto	getMetricsViewAsync (const ::std::string &view, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< MetricsAdmin::GetMetricsViewResult >>().get_future())
	Get the metrics objects for the given metrics view. More...
::Ice::StringSeq	getMetricsViewNames (::Ice::StringSeq &disabledViews, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the names of enabled and disabled metrics. More...
::std::function< void()>	getMetricsViewNamesAsync (::std::function< void(::Ice::StringSeq, ::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Get the names of enabled and disabled metrics. More...
template<template< typename > class P = ::std::promise>
auto	getMetricsViewNamesAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< MetricsAdmin::GetMetricsViewNamesResult >>().get_future())
	Get the names of enabled and disabled metrics. More...
Public Member Functions inherited from Ice::Proxy< MetricsAdminPrx, ::Ice::ObjectPrx >
::std::shared_ptr< MetricsAdminPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
::std::shared_ptr< MetricsAdminPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
::std::shared_ptr< MetricsAdminPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
::std::shared_ptr< MetricsAdminPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
::std::shared_ptr< MetricsAdminPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...
::std::shared_ptr< MetricsAdminPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...
::std::shared_ptr< MetricsAdminPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...
::std::shared_ptr< MetricsAdminPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...
::std::shared_ptr< MetricsAdminPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
::std::shared_ptr< MetricsAdminPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...
::std::shared_ptr< MetricsAdminPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...
::std::shared_ptr< MetricsAdminPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
::std::shared_ptr< MetricsAdminPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...
::std::shared_ptr< MetricsAdminPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
::std::shared_ptr< MetricsAdminPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...
::std::shared_ptr< MetricsAdminPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
::std::shared_ptr< MetricsAdminPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
::std::shared_ptr< MetricsAdminPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
::std::shared_ptr< MetricsAdminPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...
::std::shared_ptr< MetricsAdminPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
::std::shared_ptr< MetricsAdminPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...
::std::shared_ptr< MetricsAdminPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface. More...

Detailed Description

The metrics administrative facet interface.

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

Member Function Documentation

disableMetricsView()

void IceMX::MetricsAdminPrx::disableMetricsView ( const ::std::string &  name, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Disable a metrics view.

Parameters

name	The metrics view name.
context	The Context map to send with the invocation.

Exceptions

IceMX::UnknownMetricsView

Raised if the metrics view cannot be found.

disableMetricsViewAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::disableMetricsViewAsync ( const ::std::string &  name, ::std::function< void()>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Disable a metrics view.

Parameters

name	The metrics view name.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

disableMetricsViewAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::disableMetricsViewAsync ( const ::std::string &  name, const ::Ice::Context &  context = ::Ice::noExplicitContext  ) -> decltype(::std::declval<P<void>>().get_future())

inline

Disable a metrics view.

Parameters

name	The metrics view name.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

enableMetricsView()

void IceMX::MetricsAdminPrx::enableMetricsView ( const ::std::string &  name, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Enables a metrics view.

Parameters

name	The metrics view name.
context	The Context map to send with the invocation.

Exceptions

IceMX::UnknownMetricsView

Raised if the metrics view cannot be found.

enableMetricsViewAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::enableMetricsViewAsync ( const ::std::string &  name, ::std::function< void()>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Enables a metrics view.

Parameters

name	The metrics view name.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

enableMetricsViewAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::enableMetricsViewAsync ( const ::std::string &  name, const ::Ice::Context &  context = ::Ice::noExplicitContext  ) -> decltype(::std::declval<P<void>>().get_future())

inline

Enables a metrics view.

Parameters

name	The metrics view name.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

getMapMetricsFailures()

MetricsFailuresSeq IceMX::MetricsAdminPrx::getMapMetricsFailures ( const ::std::string &  view, const ::std::string &  map, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics failures associated with the given view and map.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
context	The Context map to send with the invocation.

Returns

The metrics failures associated with the map.

Exceptions

IceMX::UnknownMetricsView

Raised if the metrics view cannot be found.

getMapMetricsFailuresAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::getMapMetricsFailuresAsync ( const ::std::string &  view, const ::std::string &  map, ::std::function< void(::IceMX::MetricsFailuresSeq)>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics failures associated with the given view and map.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

getMapMetricsFailuresAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::getMapMetricsFailuresAsync ( const ::std::string &  view, const ::std::string &  map, const ::Ice::Context &  context = ::Ice::noExplicitContext  ) -> decltype(::std::declval<P<::IceMX::MetricsFailuresSeq>>().get_future())

inline

Get the metrics failures associated with the given view and map.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

getMetricsFailures()

MetricsFailures IceMX::MetricsAdminPrx::getMetricsFailures ( const ::std::string &  view, const ::std::string &  map, const ::std::string &  id, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics failure associated for the given metrics.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
id	The ID of the metrics.
context	The Context map to send with the invocation.

Returns

The metrics failures associated with the metrics.

Exceptions

IceMX::UnknownMetricsView

Raised if the metrics view cannot be found.

getMetricsFailuresAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::getMetricsFailuresAsync ( const ::std::string &  view, const ::std::string &  map, const ::std::string &  id, ::std::function< void(::IceMX::MetricsFailures)>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics failure associated for the given metrics.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
id	The ID of the metrics.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

getMetricsFailuresAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::getMetricsFailuresAsync ( const ::std::string &  view, const ::std::string &  map, const ::std::string &  id, const ::Ice::Context &  context = ::Ice::noExplicitContext  ) -> decltype(::std::declval<P<::IceMX::MetricsFailures>>().get_future())

inline

Get the metrics failure associated for the given metrics.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
id	The ID of the metrics.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

getMetricsView()

MetricsView IceMX::MetricsAdminPrx::getMetricsView ( const ::std::string &  view, long long int &  timestamp, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics objects for the given metrics view.

This returns a dictionnary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.

Parameters

view	The name of the metrics view.
timestamp	The local time of the process when the metrics object were retrieved.
context	The Context map to send with the invocation.

Returns

The metrics view data.

Exceptions

IceMX::UnknownMetricsView

Raised if the metrics view cannot be found.

getMetricsViewAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::getMetricsViewAsync ( const ::std::string &  view, ::std::function< void(::IceMX::MetricsView, long long int)>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the metrics objects for the given metrics view.

This returns a dictionnary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.

Parameters

view	The name of the metrics view.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

getMetricsViewAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::getMetricsViewAsync ( const ::std::string &  view, const ::Ice::Context &  context = ::Ice::noExplicitContext  ) -> decltype(::std::declval<P<MetricsAdmin::GetMetricsViewResult>>().get_future())

inline

Get the metrics objects for the given metrics view.

This returns a dictionnary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.

Parameters

view	The name of the metrics view.
context	The Context map to send with the invocation.

Returns

The future object for the invocation.

getMetricsViewNames()

::Ice::StringSeq IceMX::MetricsAdminPrx::getMetricsViewNames ( ::Ice::StringSeq &  disabledViews, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the names of enabled and disabled metrics.

Parameters

disabledViews	The names of the disabled views.
context	The Context map to send with the invocation.

Returns

The name of the enabled views.

getMetricsViewNamesAsync() [1/2]

::std::function<void()> IceMX::MetricsAdminPrx::getMetricsViewNamesAsync ( ::std::function< void(::Ice::StringSeq, ::Ice::StringSeq)>  response, ::std::function< void(::std::exception_ptr)>  ex = nullptr, ::std::function< void(bool)>  sent = nullptr, const ::Ice::Context &  context = ::Ice::noExplicitContext  )

inline

Get the names of enabled and disabled metrics.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns

A function that can be called to cancel the invocation locally.

getMetricsViewNamesAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceMX::MetricsAdminPrx::getMetricsViewNamesAsync ( const ::Ice::Context &  context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<MetricsAdmin::GetMetricsViewNamesResult>>().get_future())

inline

Get the names of enabled and disabled metrics.

Parameters

context

The Context map to send with the invocation.

Returns

The future object for the invocation.

ice_staticId()

static const ::std::string& IceMX::MetricsAdminPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns

The fully-scoped type ID.

---

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

• generated/cpp11/x64/Release/Ice/Metrics.h