Stub UDP transport for testing. More...

#include <udp_transport.h>

Inheritance diagram for kcenon::monitoring::stub_udp_transport:

Collaboration diagram for kcenon::monitoring::stub_udp_transport:

Public Member Functions
	stub_udp_transport ()=default

void	set_simulate_success (bool success)
	Set whether to simulate success or failure.

common::VoidResult	connect (const std::string &host, uint16_t port) override
	Connect to a remote UDP endpoint.

common::VoidResult	send (std::span< const uint8_t > data) override
	Send data to the connected endpoint.

bool	is_connected () const override
	Check if connected to an endpoint.

void	disconnect () override
	Disconnect from the current endpoint.

bool	is_available () const override
	Check if transport is available.

std::string	name () const override
	Get transport name.

udp_statistics	get_statistics () const override
	Get transport statistics.

void	reset_statistics () override
	Reset statistics.

std::string	get_host () const

uint16_t	get_port () const

common::VoidResult	send (const std::string &data)
	Send string data to the connected endpoint.

Public Member Functions inherited from kcenon::monitoring::udp_transport
virtual	~udp_transport ()=default

common::VoidResult	send (const std::string &data)
	Send string data to the connected endpoint.

Private Attributes
std::string	host_

uint16_t	port_ {0}

bool	connected_ {false}

bool	simulate_success_ {true}

std::atomic< std::size_t >	packets_sent_ {0}

std::atomic< std::size_t >	bytes_sent_ {0}

std::atomic< std::size_t >	send_failures_ {0}

Detailed Description

Stub UDP transport for testing.

This implementation simulates UDP sends without actual network calls. Useful for unit testing and when network is unavailable.

Definition at line 127 of file udp_transport.h.

Constructor & Destructor Documentation

◆ stub_udp_transport()

kcenon::monitoring::stub_udp_transport::stub_udp_transport ( )

default

Member Function Documentation

◆ connect()

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

inlineoverridevirtual

Connect to a remote UDP endpoint.

Parameters

host	Remote hostname or IP address
port	Remote port number

Returns: common::VoidResult indicating success or failure

Implements kcenon::monitoring::udp_transport.

Definition at line 150 of file udp_transport.h.

                                                                            {
        if (!simulate_success_) {
            return common::VoidResult::err(error_info(
                monitoring_error_code::network_error,
                "Simulated connection failure",
                "stub_udp_transport"
            ).to_common_error());
        }
        host_ = host;
        port_ = port;
        connected_ = true;
        return common::ok();
    }

References connected_, kcenon::monitoring::host, host_, kcenon::monitoring::network_error, port_, and simulate_success_.

◆ disconnect()

void kcenon::monitoring::stub_udp_transport::disconnect ( )

inlineoverridevirtual

Disconnect from the current endpoint.

Implements kcenon::monitoring::udp_transport.

Definition at line 192 of file udp_transport.h.

                               {
        connected_ = false;
        host_.clear();
        port_ = 0;
    }

References connected_, host_, and port_.

◆ get_host()

std::string kcenon::monitoring::stub_udp_transport::get_host ( ) const

inline

Definition at line 221 of file udp_transport.h.

221{ return host_; }

References host_.

◆ get_port()

uint16_t kcenon::monitoring::stub_udp_transport::get_port ( ) const

inline

Definition at line 222 of file udp_transport.h.

222{ return port_; }

References port_.

◆ get_statistics()

udp_statistics kcenon::monitoring::stub_udp_transport::get_statistics ( ) const

inlineoverridevirtual

Get transport statistics.

Returns: Current statistics

Implements kcenon::monitoring::udp_transport.

Definition at line 206 of file udp_transport.h.

                                                   {
        return {
            packets_sent_.load(std::memory_order_relaxed),
            bytes_sent_.load(std::memory_order_relaxed),
            send_failures_.load(std::memory_order_relaxed)
        };
    }

References bytes_sent_, packets_sent_, and send_failures_.

◆ is_available()

bool kcenon::monitoring::stub_udp_transport::is_available ( ) const

inlineoverridevirtual

Check if transport is available.

Returns: true if transport can send data

Implements kcenon::monitoring::udp_transport.

Definition at line 198 of file udp_transport.h.

                                       {
        return true;
    }

◆ is_connected()

bool kcenon::monitoring::stub_udp_transport::is_connected ( ) const

inlineoverridevirtual

Check if connected to an endpoint.

Returns: true if connected

Implements kcenon::monitoring::udp_transport.

Definition at line 188 of file udp_transport.h.

                                       {
        return connected_;
    }

References connected_.

◆ name()

std::string kcenon::monitoring::stub_udp_transport::name ( ) const

inlineoverridevirtual

Get transport name.

Returns: Transport implementation identifier

Implements kcenon::monitoring::udp_transport.

Definition at line 202 of file udp_transport.h.

                                    {
        return "stub";
    }

◆ reset_statistics()

void kcenon::monitoring::stub_udp_transport::reset_statistics ( )

inlineoverridevirtual

Reset statistics.

Implements kcenon::monitoring::udp_transport.

Definition at line 214 of file udp_transport.h.

                                     {
        packets_sent_.store(0, std::memory_order_relaxed);
        bytes_sent_.store(0, std::memory_order_relaxed);
        send_failures_.store(0, std::memory_order_relaxed);
    }

References bytes_sent_, packets_sent_, and send_failures_.

◆ 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()));
    }

◆ send() [2/2]

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

inlineoverridevirtual

Send data to the connected endpoint.

Parameters

data	Data to send

Returns: common::VoidResult indicating success or failure

Implements kcenon::monitoring::udp_transport.

Definition at line 164 of file udp_transport.h.

                                                                {
        if (!connected_) {
            send_failures_.fetch_add(1, std::memory_order_relaxed);
            return common::VoidResult::err(error_info(
                monitoring_error_code::network_error,
                "Not connected",
                "stub_udp_transport"
            ).to_common_error());
        }
 
        if (!simulate_success_) {
            send_failures_.fetch_add(1, std::memory_order_relaxed);
            return common::VoidResult::err(error_info(
                monitoring_error_code::network_error,
                "Simulated send failure",
                "stub_udp_transport"
            ).to_common_error());
        }
 
        packets_sent_.fetch_add(1, std::memory_order_relaxed);
        bytes_sent_.fetch_add(data.size(), std::memory_order_relaxed);
        return common::ok();
    }

References bytes_sent_, connected_, kcenon::monitoring::network_error, packets_sent_, send_failures_, and simulate_success_.

◆ set_simulate_success()

void kcenon::monitoring::stub_udp_transport::set_simulate_success ( bool success )

inline

Set whether to simulate success or failure.

Definition at line 146 of file udp_transport.h.

                                            {
        simulate_success_ = success;
    }

References simulate_success_, and kcenon::monitoring::success.

Member Data Documentation

◆ bytes_sent_

std::atomic<std::size_t> kcenon::monitoring::stub_udp_transport::bytes_sent_ {0}

mutableprivate

Definition at line 134 of file udp_transport.h.

134{0};

Referenced by get_statistics(), reset_statistics(), and send().

◆ connected_

bool kcenon::monitoring::stub_udp_transport::connected_ {false}

private

Definition at line 131 of file udp_transport.h.

131{false};

Referenced by connect(), disconnect(), is_connected(), and send().

◆ host_

std::string kcenon::monitoring::stub_udp_transport::host_

private

Definition at line 129 of file udp_transport.h.

Referenced by connect(), disconnect(), and get_host().

◆ packets_sent_

std::atomic<std::size_t> kcenon::monitoring::stub_udp_transport::packets_sent_ {0}

mutableprivate

Definition at line 133 of file udp_transport.h.

133{0};

Referenced by get_statistics(), reset_statistics(), and send().

◆ port_

uint16_t kcenon::monitoring::stub_udp_transport::port_ {0}

private

Definition at line 130 of file udp_transport.h.

130{0};

Referenced by connect(), disconnect(), and get_port().

◆ send_failures_

std::atomic<std::size_t> kcenon::monitoring::stub_udp_transport::send_failures_ {0}

mutableprivate

Definition at line 135 of file udp_transport.h.

135{0};

Referenced by get_statistics(), reset_statistics(), and send().

◆ simulate_success_

bool kcenon::monitoring::stub_udp_transport::simulate_success_ {true}

private

Definition at line 132 of file udp_transport.h.

132{true};

Referenced by connect(), send(), and set_simulate_success().

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

include/kcenon/monitoring/exporters/udp_transport.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ stub_udp_transport()

Member Function Documentation

◆ connect()

◆ disconnect()

◆ get_host()

◆ get_port()

◆ get_statistics()

◆ is_available()

◆ is_connected()

◆ name()

◆ reset_statistics()

◆ send() [1/2]

◆ send() [2/2]

◆ set_simulate_success()

Member Data Documentation

◆ bytes_sent_

◆ connected_

◆ host_

◆ packets_sent_

◆ port_

◆ send_failures_

◆ simulate_success_