endpoint_ping_report Class Reference

#include <couchbase/endpoint_ping_report.hxx>

Public Member Functions
	endpoint_ping_report ()=default
	endpoint_ping_report (service_type type, std::string id, std::string local, std::string remote, ping_state state, std::optional< std::string > error, std::optional< std::string > endpoint_namespace, std::chrono::microseconds latency)
auto	type () const -> service_type
	Returns the service type for this endpoint.
auto	id () const -> std::string
	Returns the ID for this endpoint.
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	state () const -> ping_state
	Returns the state of this ping when assembling the report.
auto	error () const -> std::optional< std::string >
	Returns the reason this ping did not succeed, if applicable.
auto	endpoint_namespace () const -> std::optional< std::string >
	Returns the namespace of this endpoint (likely the bucket name if present).
auto	latency () const -> std::chrono::microseconds
	Returns the latency of this ping.

Constructor & Destructor Documentation

endpoint_ping_report() [1/2]

endpoint_ping_report ( )

default

Since

1.0.0

Internal

Internal interface

endpoint_ping_report() [2/2]

endpoint_ping_report ( service_type type, std::string id, std::string local, std::string remote, ping_state state, std::optional< std::string > error, std::optional< std::string > endpoint_namespace, std::chrono::microseconds latency )

inline

Since

1.0.0

Internal

Internal interface

Member Function Documentation

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

error()

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

inlinenodiscard

Returns the reason this ping did not succeed, if applicable.

Returns

error description.

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

latency()

auto latency ( ) const -> std::chrono::microseconds

inlinenodiscard

Returns the latency of this ping.

Returns

the latency in microseconds.

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 -> ping_state

inlinenodiscard

Returns the state of this ping when assembling the report.

Returns

the ping 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_ping_report.hxx