A generic wrapper for socket options. More...
#include <io/socket/socket_option.hpp>
Inheritance diagram for io::socket::socket_option< T >:
Public Types | |
| using | value_type = std::decay_t< T > |
| The type of the socket option value. | |
| using | size_type = std::size_t |
| The size type for the socket option. | |
Public Member Functions | |
| template<size_type Size = sizeof(value_type)> requires (Size <= sizeof(value_type)) | |
| constexpr | socket_option (size_type size=Size) noexcept |
| Constructs a socket_option with a given size. | |
| socket_option (const socket_option &)=default | |
| Default copy constructor. | |
| socket_option (socket_option &&)=default | |
| Default move constructor. | |
| socket_option (const value_type &val) noexcept | |
| Constructs a socket_option from a value. | |
| template<size_type Size> requires (Size <= sizeof(value_type) || Size == std::dynamic_extent) | |
| socket_option (std::span< const std::byte, Size > option) noexcept | |
| Constructs a socket_option from a span of bytes. | |
| template<size_type Size> requires (Size <= sizeof(value_type) || Size == std::dynamic_extent) | |
| socket_option (std::span< std::byte, Size > option) noexcept | |
| Constructs a socket_option from a span of bytes. | |
| auto | operator= (const socket_option &) -> socket_option &=default |
| Default copy assignment operator. | |
| auto | operator= (socket_option &&) -> socket_option &=default |
| Default move assignment operator. | |
| ~socket_option ()=default | |
| Default destructor. | |
| constexpr auto | operator* () noexcept -> value_type & |
| Dereferences the socket option to its value. | |
| constexpr auto | operator-> () noexcept -> value_type * |
| Accesses the socket option's value. | |
| constexpr auto | begin () noexcept -> std::byte * |
| Gets an iterator to the beginning of the option's byte representation. | |
| constexpr auto | begin () const noexcept -> const std::byte * |
| Gets a const iterator to the beginning of the option's byte representation. | |
| constexpr auto | end () noexcept -> std::byte * |
| Gets an iterator to the end of the option's byte representation. | |
| constexpr auto | end () const noexcept -> const std::byte * |
| Gets a const iterator to the end of the option's byte representation. | |
| auto | operator<=> (const socket_option &other) const noexcept -> bool |
| Compares this socket_option with another for ordering. | |
| auto | operator== (const socket_option &other) const noexcept -> bool |
| Compares two socket_option objects for equality. | |
Detailed Description
template<typename T>
requires std::is_trivially_copyable_v<T>
class io::socket::socket_option< T >
requires std::is_trivially_copyable_v<T>
class io::socket::socket_option< T >
A generic wrapper for socket options.
- Template Parameters
-
T The type of the socket option value.
Constructor & Destructor Documentation
◆ socket_option() [1/4]
template<typename T >
|
inlineconstexprnoexcept |
Constructs a socket_option with a given size.
- Template Parameters
-
Size The size of the option.
- Parameters
-
size The size of the option in bytes.
◆ socket_option() [2/4]
template<typename T >
|
inlinenoexcept |
Constructs a socket_option from a value.
- Parameters
-
val The value of the socket option.
◆ socket_option() [3/4]
template<typename T >
|
inlinenoexcept |
Constructs a socket_option from a span of bytes.
- Template Parameters
-
Size The size of the span.
- Parameters
-
option The span of bytes representing the option.
◆ socket_option() [4/4]
template<typename T >
|
inlinenoexcept |
Constructs a socket_option from a span of bytes.
- Template Parameters
-
Size The size of the span.
- Parameters
-
option The span of bytes representing the option.
Member Function Documentation
◆ begin() [1/2]
template<typename T >
|
inlineconstexprnoexcept |
Gets a const iterator to the beginning of the option's byte representation.
- Returns
- A const pointer to the beginning of the byte storage.
◆ begin() [2/2]
template<typename T >
|
inlineconstexprnoexcept |
Gets an iterator to the beginning of the option's byte representation.
- Returns
- A pointer to the beginning of the byte storage.
◆ end() [1/2]
template<typename T >
|
inlineconstexprnoexcept |
Gets a const iterator to the end of the option's byte representation.
- Returns
- A const pointer to the end of the byte storage.
◆ end() [2/2]
template<typename T >
|
inlineconstexprnoexcept |
Gets an iterator to the end of the option's byte representation.
- Returns
- A pointer to the end of the byte storage.
◆ operator*()
template<typename T >
|
inlineconstexprnoexcept |
Dereferences the socket option to its value.
- Returns
- A reference to the socket option's value.
◆ operator->()
template<typename T >
|
inlineconstexprnoexcept |
Accesses the socket option's value.
- Returns
- A pointer to the socket option's value.
◆ operator<=>()
template<typename T >
|
inlinenoexcept |
Compares this socket_option with another for ordering.
- Parameters
-
other The other socket_option to compare with.
- Returns
- The result of the lexicographical comparison, first by size, then by the raw byte data.
◆ operator=() [1/2]
template<typename T >
|
default |
Default copy assignment operator.
- Returns
- A reference to this object.
◆ operator=() [2/2]
template<typename T >
|
default |
Default move assignment operator.
- Returns
- A reference to this object.
◆ operator==()
template<typename T >
|
inlinenoexcept |
Compares two socket_option objects for equality.
- Parameters
-
other The other socket_option to compare against.
- Returns
- True if the options are equal, false otherwise.
The documentation for this class was generated from the following file:
- /home/runner/work/async-berkeley/async-berkeley/include/io/socket/socket_option.hpp
