endpoint_diagnostics Class Reference

#include <couchbase/endpoint_diagnostics.hxx>

Public Member Functions
	endpoint_diagnostics ()=default
	endpoint_diagnostics (service_type type, std::string id, std::optional< std::chrono::microseconds > last_activity, std::string local, std::string remote, std::optional< std::string > endpoint_namespace, endpoint_state state, std::optional< std::string > details)
auto	type () const -> service_type
	Returns the service type for this endpoint.
auto	id () const -> std::string
	Returns the ID for this endpoint.
auto	last_activity () const -> std::optional< std::chrono::microseconds >
	Returns the time since the last activity, if there has been one.
auto	local () const -> std::string
	Returns the local socket address for this endpoint.
auto	remote () const -> std::string
	Returns the remote socket address for this endpoint.
auto	endpoint_namespace () const -> std::optional< std::string >
	Returns the namespace of this endpoint (likely the bucket name if present).
auto	state () const -> endpoint_state
	Returns the current state of the endpoint.
auto	details () const -> std::optional< std::string >
	Returns any additional details about the endpoint, if available.

Constructor & Destructor Documentation

endpoint_diagnostics() [1/2]

endpoint_diagnostics ( )

default

endpoint_diagnostics() [2/2]

endpoint_diagnostics ( service_type type, std::string id, std::optional< std::chrono::microseconds > last_activity, std::string local, std::string remote, std::optional< std::string > endpoint_namespace, endpoint_state state, std::optional< std::string > details )

inline

Since

1.0.0

Internal

Internal interface

Member Function Documentation

details()

auto details ( ) const -> std::optional< std::string >

inlinenodiscard

Returns any additional details about the endpoint, if available.

Returns

endpoint details.

Since

1.0.0

Committed

Generally available API and should be preferred in production

endpoint_namespace()

auto endpoint_namespace ( ) const -> std::optional< std::string >

inlinenodiscard

Returns the namespace of this endpoint (likely the bucket name if present).

Returns

the namespace.

Since

1.0.0

Committed

Generally available API and should be preferred in production

id()

auto id ( ) const -> std::string

inlinenodiscard

Returns the ID for this endpoint.

Returns

the endpoint ID.

Since

1.0.0

Committed

Generally available API and should be preferred in production

last_activity()

auto last_activity ( ) const -> std::optional< std::chrono::microseconds >

inlinenodiscard

Returns the time since the last activity, if there has been one.

Returns

the duration since the last activity.

Since

1.0.0

Committed

Generally available API and should be preferred in production

local()

auto local ( ) const -> std::string

inlinenodiscard

Returns the local socket address for this endpoint.

Returns

the local socket address.

Since

1.0.0

Committed

Generally available API and should be preferred in production

remote()

auto remote ( ) const -> std::string

inlinenodiscard

Returns the remote socket address for this endpoint.

Returns

the remote socket address.

Since

1.0.0

Committed

Generally available API and should be preferred in production

state()

auto state ( ) const -> endpoint_state

inlinenodiscard

Returns the current state of the endpoint.

Returns

the endpoint state.

Since

1.0.0

Committed

Generally available API and should be preferred in production

type()

auto type ( ) const -> service_type

inlinenodiscard

Returns the service type for this endpoint.

Returns

the service type.

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/endpoint_diagnostics.hxx