kcenon::monitoring::udp_transport Class Reference

Abstract UDP transport interface. More...

#include <udp_transport.h>

Inheritance diagram for kcenon::monitoring::udp_transport:

Collaboration diagram for kcenon::monitoring::udp_transport:

Public Member Functions
virtual	~udp_transport ()=default
virtual common::VoidResult	connect (const std::string &host, uint16_t port)=0
	Connect to a remote UDP endpoint.
virtual common::VoidResult	send (std::span< const uint8_t > data)=0
	Send data to the connected endpoint.
common::VoidResult	send (const std::string &data)
	Send string data to the connected endpoint.
virtual bool	is_connected () const =0
	Check if connected to an endpoint.
virtual void	disconnect ()=0
	Disconnect from the current endpoint.
virtual bool	is_available () const =0
	Check if transport is available.
virtual std::string	name () const =0
	Get transport name.
virtual udp_statistics	get_statistics () const =0
	Get transport statistics.
virtual void	reset_statistics ()=0
	Reset statistics.

Detailed Description

Abstract UDP transport interface.

Provides a common interface for UDP-based metric delivery, with implementations for stub (testing), simple (basic), and network_system-backed transports.

Definition at line 55 of file udp_transport.h.

Constructor & Destructor Documentation

~udp_transport()

virtual kcenon::monitoring::udp_transport::~udp_transport ( )

virtualdefault

Member Function Documentation

connect()

virtual common::VoidResult kcenon::monitoring::udp_transport::connect ( const std::string & host, uint16_t port )

pure virtual

Connect to a remote UDP endpoint.

Parameters

host	Remote hostname or IP address
port	Remote port number

Returns

common::VoidResult indicating success or failure

Implemented in kcenon::monitoring::stub_udp_transport.

disconnect()

virtual void kcenon::monitoring::udp_transport::disconnect ( )

pure virtual

Disconnect from the current endpoint.

Implemented in kcenon::monitoring::stub_udp_transport.

get_statistics()

virtual udp_statistics kcenon::monitoring::udp_transport::get_statistics ( ) const

pure virtual

Get transport statistics.

Returns

Current statistics

Implemented in kcenon::monitoring::stub_udp_transport.

is_available()

virtual bool kcenon::monitoring::udp_transport::is_available ( ) const

pure virtual

Check if transport is available.

Returns

true if transport can send data

Implemented in kcenon::monitoring::stub_udp_transport.

is_connected()

virtual bool kcenon::monitoring::udp_transport::is_connected ( ) const

pure virtual

Check if connected to an endpoint.

Returns

true if connected

Implemented in kcenon::monitoring::stub_udp_transport.

name()

virtual std::string kcenon::monitoring::udp_transport::name ( ) const

pure virtual

Get transport name.

Returns

Transport implementation identifier

Implemented in kcenon::monitoring::stub_udp_transport.

reset_statistics()

virtual void kcenon::monitoring::udp_transport::reset_statistics ( )

pure virtual

Reset statistics.

Implemented in kcenon::monitoring::stub_udp_transport.

send() [1/2]

common::VoidResult kcenon::monitoring::udp_transport::send ( const std::string & data )

inline

Send string data to the connected endpoint.

Parameters

data	String data to send

Returns

common::VoidResult indicating success or failure

Definition at line 79 of file udp_transport.h.

                                                 {
        return send(std::span<const uint8_t>(
            reinterpret_cast<const uint8_t*>(data.data()),
            data.size()));
    }

References send().

Here is the call graph for this function:

send() [2/2]

virtual common::VoidResult kcenon::monitoring::udp_transport::send ( std::span< const uint8_t > data )

pure virtual

Send data to the connected endpoint.

Parameters

data	Data to send

Returns

common::VoidResult indicating success or failure

Implemented in kcenon::monitoring::stub_udp_transport.

Referenced by send().

Here is the caller graph for this function:

---

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

• include/kcenon/monitoring/exporters/udp_transport.h