kcenon::network::concepts::socket_read_guard< S > Class Template Reference

RAII guard for socket read loop. More...

#include <socket_concepts.h>

Collaboration diagram for kcenon::network::concepts::socket_read_guard< S >:

Public Member Functions
	socket_read_guard (S &socket)
	~socket_read_guard ()
	socket_read_guard (const socket_read_guard &)=delete
socket_read_guard &	operator= (const socket_read_guard &)=delete

Private Attributes
S &	socket_

Detailed Description

template<StreamSocket S>
class kcenon::network::concepts::socket_read_guard< S >

RAII guard for socket read loop.

Ensures stop_read() is called when the guard goes out of scope.

Example usage:

template<StreamSocket S>
void process_socket(S& socket) {
    socket_read_guard guard{socket};
    socket.start_read();
    // ... socket will stop reading when guard is destroyed
}

Definition at line 357 of file socket_concepts.h.

Constructor & Destructor Documentation

socket_read_guard() [1/2]

template<StreamSocket S>

kcenon::network::concepts::socket_read_guard< S >::socket_read_guard ( S & socket )

inlineexplicit

Definition at line 360 of file socket_concepts.h.

: socket_(socket) {}

~socket_read_guard()

template<StreamSocket S>

kcenon::network::concepts::socket_read_guard< S >::~socket_read_guard ( )

inline

Definition at line 361 of file socket_concepts.h.

{ socket_.stop_read(); }

References kcenon::network::concepts::socket_read_guard< S >::socket_.

socket_read_guard() [2/2]

template<StreamSocket S>

kcenon::network::concepts::socket_read_guard< S >::socket_read_guard ( const socket_read_guard< S > & )

delete

Member Function Documentation

operator=()

template<StreamSocket S>

socket_read_guard & kcenon::network::concepts::socket_read_guard< S >::operator= ( const socket_read_guard< S > & )

delete

Member Data Documentation

socket_

template<StreamSocket S>

S& kcenon::network::concepts::socket_read_guard< S >::socket_

private

Definition at line 367 of file socket_concepts.h.

Referenced by kcenon::network::concepts::socket_read_guard< S >::~socket_read_guard().

---

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

• include/kcenon/network/detail/concepts/socket_concepts.h