concepts_example.cpp File Reference

Demonstrates usage of C++20 concepts in network_system. More...

#include <kcenon/network/concepts/concepts.h>
#include <functional>
#include <iostream>
#include <memory>
#include <string>
#include <system_error>
#include <vector>

Include dependency graph for concepts_example.cpp:

Go to the source code of this file.

Classes
class	ConceptClient
	A client class demonstrating concept-constrained callbacks. More...
class	MockNetworkClient
	A mock client satisfying NetworkClient concept. More...
class	XorTransformer
	A simple XOR "encryption" transformer. More...

Functions
template<ByteBuffer Buffer>
void	send_buffer (const Buffer &buffer)
	Send data from any buffer type satisfying ByteBuffer concept.
void	demonstrate_byte_buffer ()
template<MutableByteBuffer Buffer>
void	receive_into (Buffer &buffer, std::size_t expected_size)
	Receive data into a resizable buffer.
void	demonstrate_mutable_buffer ()
void	demonstrate_callbacks ()
template<NetworkClient Client>
void	use_client (Client &client, const std::string &message)
	Generic function that works with any NetworkClient.
void	demonstrate_network_client ()
template<ReversibleDataTransformer T>
void	process_bidirectional (T &transformer, std::vector< uint8_t > &data)
	Apply a reversible transformer to data.
void	demonstrate_transformer ()
template<Duration D>
void	set_timeout (D duration)
	Set a timeout using any duration type.
void	demonstrate_duration ()
int	main ()

Detailed Description

Demonstrates usage of C++20 concepts in network_system.

BSD 3-Clause License Copyright (c) 2024, Network System Project

This example shows how to use network_system concepts for:

• Compile-time type validation
• Better error messages
• Self-documenting template interfaces

Requirements:

• C++20 compiler (GCC 10+, Clang 10+, MSVC 2022+)

Definition in file concepts_example.cpp.

Function Documentation

demonstrate_byte_buffer()

void demonstrate_byte_buffer

(

)

Definition at line 44 of file concepts_example.cpp.

                               {
    std::cout << "=== ByteBuffer Concept ===\n";
 
    // Works with std::vector<uint8_t>
    std::vector<uint8_t> vec_buffer = {1, 2, 3, 4, 5};
    send_buffer(vec_buffer);
 
    // Works with std::string
    std::string str_buffer = "Hello, Network!";
    send_buffer(str_buffer);
 
    // Works with std::array
    std::array<uint8_t, 4> arr_buffer = {0xDE, 0xAD, 0xBE, 0xEF};
    send_buffer(arr_buffer);
 
    // The following would NOT compile (good!):
    // int x = 42;
    // send_buffer(x);  // Error: 'int' does not satisfy 'ByteBuffer'
 
    std::cout << "\n";
}

References send_buffer().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

demonstrate_callbacks()

void demonstrate_callbacks

(

)

Definition at line 180 of file concepts_example.cpp.

                             {
    std::cout << "=== Callback Concepts ===\n";
 
    ConceptClient client;
 
    // Lambda callbacks - all types are validated at compile time
    client.on_data([](const std::vector<uint8_t>& data) {
        std::cout << "Received " << data.size() << " bytes\n";
    });
 
    client.on_error([](std::error_code ec) {
        std::cout << "Error: " << ec.message() << "\n";
    });
 
    client.on_connect([]() {
        std::cout << "Connected!\n";
    });
 
    client.on_retry([](std::size_t attempt) {
        std::cout << "Retry attempt #" << attempt << "\n";
    });
 
    client.simulate_events();
 
    // Invalid callbacks would fail at compile time:
    // client.on_data([](int x) {});           // Wrong parameter type
    // client.on_error([](std::string s) {});  // Wrong parameter type
    // client.on_connect([](int x) {});        // Handler should take no args
 
    std::cout << "\n";
}

Referenced by main().

Here is the caller graph for this function:

demonstrate_duration()

void demonstrate_duration

(

)

Definition at line 347 of file concepts_example.cpp.

                            {
    std::cout << "=== Duration Concept ===\n";
 
    set_timeout(std::chrono::seconds(30));
    set_timeout(std::chrono::milliseconds(500));
    set_timeout(std::chrono::microseconds(100000));
 
    // Invalid: raw integers don't satisfy Duration
    // set_timeout(5);  // Error: 'int' does not satisfy 'Duration'
 
    std::cout << "\n";
}

References set_timeout().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

demonstrate_mutable_buffer()

void demonstrate_mutable_buffer

(

)

Definition at line 84 of file concepts_example.cpp.

                                  {
    std::cout << "=== MutableByteBuffer Concept ===\n";
 
    std::vector<uint8_t> buffer;
    receive_into(buffer, 100);
    std::cout << "Received data, first byte: " << static_cast<int>(buffer[0]) << "\n";
 
    // std::array does NOT satisfy MutableByteBuffer (no resize)
    // std::array<uint8_t, 10> arr;
    // receive_into(arr, 5);  // Error: no resize() method
 
    std::cout << "\n";
}

References receive_into().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

demonstrate_network_client()

void demonstrate_network_client

(

)

Definition at line 256 of file concepts_example.cpp.

                                  {
    std::cout << "=== NetworkClient Concept ===\n";
 
    MockNetworkClient client;
 
    // Try to send before connecting
    use_client(client, "Hello");
 
    // Connect and send
    client.connect();
    use_client(client, "Hello, World!");
 
    // Stop client
    client.stop_client();
 
    std::cout << "\n";
}

References use_client().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

demonstrate_transformer()

void demonstrate_transformer

(

)

Definition at line 322 of file concepts_example.cpp.

                               {
    std::cout << "=== DataTransformer Concept ===\n";
 
    XorTransformer xor_transform(0x42);
    std::vector<uint8_t> data = {'H', 'e', 'l', 'l', 'o'};
 
    process_bidirectional(xor_transform, data);
 
    std::cout << "\n";
}

References process_bidirectional().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

main()

int main

(

)

Definition at line 392 of file concepts_example.cpp.

           {
    std::cout << "==============================================\n";
    std::cout << "Network System - C++20 Concepts Example\n";
    std::cout << "==============================================\n\n";
 
    demonstrate_byte_buffer();
    demonstrate_mutable_buffer();
    demonstrate_callbacks();
    demonstrate_network_client();
    demonstrate_transformer();
    demonstrate_duration();
 
    std::cout << "==============================================\n";
    std::cout << "All examples completed successfully!\n";
    std::cout << "==============================================\n";
 
    return 0;
}

References demonstrate_byte_buffer(), demonstrate_callbacks(), demonstrate_duration(), demonstrate_mutable_buffer(), demonstrate_network_client(), and demonstrate_transformer().

Here is the call graph for this function:

process_bidirectional()

template<ReversibleDataTransformer T>

void process_bidirectional	(	T &	transformer,
		std::vector< uint8_t > &	data )

Apply a reversible transformer to data.

Template Parameters

T	Must satisfy ReversibleDataTransformer

Definition at line 306 of file concepts_example.cpp.

                                                                     {
    std::cout << "Original: ";
    for (auto b : data) std::cout << static_cast<char>(b);
    std::cout << "\n";
 
    transformer.transform(data);
    std::cout << "Transformed: ";
    for (auto b : data) std::cout << std::hex << static_cast<int>(b) << " ";
    std::cout << std::dec << "\n";
 
    transformer.reverse_transform(data);
    std::cout << "Restored: ";
    for (auto b : data) std::cout << static_cast<char>(b);
    std::cout << "\n";
}

Referenced by demonstrate_transformer().

Here is the caller graph for this function:

receive_into()

template<MutableByteBuffer Buffer>

void receive_into	(	Buffer &	buffer,
		std::size_t	expected_size )

Receive data into a resizable buffer.

Template Parameters

Buffer

Must satisfy MutableByteBuffer (ByteBuffer + resize)

Definition at line 75 of file concepts_example.cpp.

                                                           {
    buffer.resize(expected_size);
    std::cout << "Buffer resized to " << buffer.size() << " bytes\n";
    // Fill with dummy data
    for (std::size_t i = 0; i < buffer.size(); ++i) {
        static_cast<uint8_t*>(buffer.data())[i] = static_cast<uint8_t>(i % 256);
    }
}

Referenced by demonstrate_mutable_buffer().

Here is the caller graph for this function:

send_buffer()

template<ByteBuffer Buffer>

void send_buffer

(

const Buffer &

buffer

)

Send data from any buffer type satisfying ByteBuffer concept.

Template Parameters

Buffer

Must satisfy ByteBuffer (has data() and size())

Definition at line 37 of file concepts_example.cpp.

                                       {
    std::cout << "Sending " << buffer.size() << " bytes from buffer\n";
    // Access is compile-time guaranteed
    const void* ptr = buffer.data();
    (void)ptr;  // Suppress unused warning in example
}

Referenced by demonstrate_byte_buffer().

Here is the caller graph for this function:

set_timeout()

template<Duration D>

void set_timeout

(

D

duration

)

Set a timeout using any duration type.

Template Parameters

D	Must satisfy Duration concept

Definition at line 342 of file concepts_example.cpp.

                             {
    auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(duration);
    std::cout << "Timeout set to " << ms.count() << " milliseconds\n";
}

Referenced by demonstrate_duration().

Here is the caller graph for this function:

use_client()

template<NetworkClient Client>

void use_client	(	Client &	client,
		const std::string &	message )

Generic function that works with any NetworkClient.

Template Parameters

Client

Must satisfy NetworkClient concept

Definition at line 246 of file concepts_example.cpp.

                                                          {
    if (!client.is_connected()) {
        std::cout << "Client not connected, cannot send\n";
        return;
    }
 
    std::vector<uint8_t> data(message.begin(), message.end());
    client.send_packet(std::move(data));
}

Referenced by demonstrate_network_client().

Here is the caller graph for this function: