Namespaces
namespace	details

namespace	utf16

namespace	utf8

Classes
struct	AddressInfo
	address change notification payload. More...

class	Arp
	ARP protocol class. More...

class	Backoff
	adaptive backoff for busy-wait loops, requires Rdtsc::calibrate (). More...

class	Base64
	base64 encode, decode class. More...

struct	BasicAsyncAccept
	asynchronous accept operation. More...

class	BasicAsyncDatagramSocket
	asynchronous datagram socket class. More...

struct	BasicAsyncOpTraits
	asynchronous operation traits. More...

class	BasicAsyncRawSocket
	asynchronous raw socket class. More...

struct	BasicAsyncRead
	asynchronous read operation. More...

class	BasicAsyncSocket
	basic asynchronous socket class. More...

class	BasicAsyncStreamAcceptor
	asynchronous stream acceptor class. More...

class	BasicAsyncStreamSocket
	asynchronous stream socket class. More...

struct	BasicAsyncWait
	asynchronous wait operation. More...

struct	BasicAsyncWrite
	asynchronous write operation. More...

class	BasicBumpAllocator
	bump allocator owning its backends. More...

class	BasicDatagramNameServer
	basic DNS name server over datagram socket. More...

class	BasicDatagramPeer
	mDNS peer. More...

class	BasicDatagramResolver
	basic DNS resolver over datagram socket. More...

class	BasicDatagramSocket
	basic datagram socket class. More...

class	BasicDhcp
	carries DHCP messages over a packet socket. More...

class	BasicDhcpClient
	DHCP client. More...

class	BasicDhcpServer
	DHCP server. More...

class	BasicDtlsWrapper
	DTLS decorator for datagram sockets. More...

class	BasicEndpoint
	basic endpoint class. More...

class	BasicFutex
	Futex-based mutex for intra-process locking. More...

class	BasicHttpClient
	basic HTTP client. More...

struct	BasicHttpContent
	basic HTTP content. More...

class	BasicHttpSecureClient
	basic HTTPS client. More...

class	BasicHttpSecureServer
	basic HTTPS server. More...

class	BasicHttpServer
	basic HTTP server. More...

class	BasicHttpWorker
	basic HTTP worker. More...

class	BasicInternetEndpoint
	basic internet endpoint class. More...

class	BasicJsonReader
	JSON reader class. More...

class	BasicJsonWriter
	JSON writer class. More...

class	BasicLinkLayerEndpoint
	basic link layer endpoint class. More...

struct	BasicMember
	member. More...

class	BasicNdp
	carries NDP messages over an ICMPv6 socket. More...

class	BasicNdpClient
	NDP client, solicits routers and receives their advertisements. More...

class	BasicNdpServer
	NDP server, receives router solicitations and sends advertisements. More...

class	BasicNetlinkEndpoint
	basic netlink endpoint class. More...

class	BasicProactor
	basic proactor class. More...

class	BasicProactorThread
	Convenience class that owns a Proactor running on a dedicated background thread. More...

class	BasicQueue
	queue base class. More...

class	BasicRawSocket
	basic raw socket class. More...

class	BasicSharedFutex
	Futex-based mutex suitable for inter-process locking via shared memory. More...

class	BasicSlabAllocator
	slab allocator owning a backend and managing one or more pools. More...

union	BasicSlabChunk
	basic chunk. More...

struct	BasicSlabPool
	free-list pool operating over a pre-existing memory region. More...

struct	BasicSlabSegment
	segment header. More...

class	BasicSmtpClient
	basic SMTP client. More...

class	BasicSmtpSecureClient
	Basic SMTPS client. More...

class	BasicSocket
	basic socket class. More...

class	BasicSocketStream
	socket stream class. More...

class	BasicSocketStreambuf
	socket stream buffer class. More...

class	BasicStats
	lock-free, multi-producer-safe performance statistics collector. More...

class	BasicStreamAcceptor
	basic stream acceptor class. More...

class	BasicStreamSocket
	basic stream socket class. More...

class	BasicTimer
	base timer class. More...

class	BasicTls
	basic TLS/DTLS decorator. More...

class	BasicTlsResolver
	basic DNS resolver over TLS socket (DNS over TLS). More...

class	BasicTlsStream
	TLS stream class. More...

class	BasicTlsWrapper
	TLS decorator for stream sockets. More...

class	BasicUnixEndpoint
	basic unix endpoint class. More...

class	BasicWheel
	timing wheel. More...

struct	BigNumDelete
	custom functor for BIGNUM deletion. More...

class	BumpAtomic
	bump sync policy using a lock-free cursor. More...

class	BumpPlain
	bump sync policy using a plain cursor, single thread only. More...

class	Cache
	File cache. More...

class	Chunkstream
	chunk stream. More...

class	Chunkstreambuf
	chunk stream buffer. More...

class	CompletionHandler
	completion handler interface class. More...

class	Condition
	condition variable class. More...

class	CpuTopology
	CPU topology detector. More...

class	Decoder
	decoder. More...

class	Decoderbuf
	decoder stream buffer. More...

class	Dhcp
	dynamic host configuration protocol class. More...

class	DhcpMessage
	DHCP message codec. More...

class	DhcpOption
	DHCP option list. More...

struct	DhcpPacket
	DHCP message. More...

struct	DhKeyDelete
	Custom functor for DH key deletion. More...

class	Digest
	digest stream. More...

class	Digestbuf
	digest stream buffer. More...

class	DigestCategory
	digest error category. More...

class	Dns
	DNS over UDP protocol class. More...

class	DnsMessage
	DNS message codec. More...

struct	DnsPacket
	DNS packet. More...

class	Dot
	DNS over TLS protocol class. More...

class	Dtls
	DTLS protocol class (DTLS over UDP). More...

struct	EcdhKeyDelete
	Custom functor for ECDH key deletion. More...

struct	EcdsaSigDelete
	custom functor for ECDSA_SIG deletion. More...

class	Encoder
	encoder. More...

class	Encoderbuf
	encoder stream buffer. More...

class	ErrorCategory
	Error category. More...

class	EventHandler
	Event handler interface class. More...

struct	EvpEncodeCtxDelete
	custom functor for EVP_ENCODE_CTX deletion. More...

struct	EvpMdCtxDelete
	custom functor for EVP_MD_CTX deletion. More...

struct	EvpPkeyCtxDelete
	custom functor for EVP_PKEY_CTX deletion. More...

struct	EvpPkeyDelete
	custom functor for EVP_PKEY deletion. More...

class	Function
	fixed-capacity move-only allocation-free alternative to std::function. More...

class	Function< Return(Args...), Capacity, Alignment >
	fixed-capacity move-only allocation-free alternative to std::function. More...

class	HeapMem
	heap memory provider. More...

class	Hmac
	HMAC stream. More...

class	Hmacbuf
	HMAC stream buffer. More...

struct	HmacCtxDelete
	custom functor for HMAC_CTX deletion. More...

class	Http
	HTTP protocol class (HTTP over TCP). More...

class	HttpCategory
	HTTP API generic error category. More...

class	HttpMessage
	HTTP message. More...

class	HttpRequest
	HTTP request. More...

class	HttpResponse
	HTTP response. More...

class	Https
	HTTPS protocol class (HTTP over TLS). More...

class	Icmp
	ICMP protocol class. More...

class	Interface
	interface class. More...

class	InterfaceManager
	interface manager class. More...

class	Invoker
	thread invoker class. More...

struct	IoDefaultPolicy

struct	IoHybridPolicy

struct	IoOperation
	Describes a single asynchronous operation submitted to the Proactor. More...

class	IoRingBuffer
	pool of buffers provided to the I/O backend. More...

struct	IoSqpollPolicy

class	IpAddress
	IPv6, IPv4 address class. More...

class	IpAddressImpl
	IP address implementation interface. More...

class	Ipv4Address
	IPv4 address implementation. More...

class	Ipv6Address
	IPv6 address implementation. More...

class	JsonCategory
	JSON error category. More...

struct	LinkInfo
	link change notification payload. More...

class	LocalMem
	local anonymous memory provider. More...

struct	LogicalCpu
	logical CPU (hardware thread). More...

class	MacAddress
	MAC address class. More...

class	Mdns
	Multicast DNS protocol class. More...

class	Monotonic
	monotonic clock policy (stable, adjusted, recommended default). More...

class	MonotonicRaw
	raw monotonic clock policy (raw hardware clock, may drift). More...

struct	Mpmc
	multiple producer multiple consumer ring buffer. More...

struct	Mpsc
	multiple producer single consumer ring buffer. More...

class	Mutex
	class used to protect shared data from being simultaneously accessed by multiple threads. More...

struct	NanoClock
	minimal clock type used as a type tag for time_point parameterization. More...

class	Ndp
	neighbor discovery protocol class. More...

class	NdpMessage
	NDP message codec. More...

struct	NdpPrefix
	prefix carried by a router advertisement, RFC 4861 section 4.6.2. More...

struct	NdpRdnss
	recursive DNS servers carried by a router advertisement, RFC 8106 section 5.1. More...

class	Neighbor
	class representing a single ARP / NDP neighbor cache entry. More...

struct	NeighborAdvertisement
	neighbor advertisement, RFC 4861 section 4.4. More...

struct	NeighborInfo
	neighbor change notification payload. More...

struct	NeighborKey
	key identifying a neighbor cache entry. More...

class	NeighborManager
	ARP / NDP neighbor manager class. More...

struct	NeighborSolicitation
	neighbor solicitation, RFC 4861 section 4.3. More...

class	Netlink
	netlink protocol class. More...

class	NetlinkManager
	base class for netlink-based managers. More...

struct	NumaNode
	NUMA node containing multiple cores. More...

struct	overload
	overload resolution. More...

struct	overload< First, Ts... >
	overload resolution. More...

struct	overload< void, Ts... >
	overload resolution. More...

struct	overload<>
	overload resolution. More...

class	PackReader
	message pack reader class. More...

class	PackWriter
	message pack writer class. More...

struct	PhysicalCore
	physical CPU core (may have multiple logical CPU). More...

class	Ping
	ICMP echo client. More...

struct	PingAnswer
	answer to an echo request. More...

class	PingStats
	ICMP echo statistics. More...

class	PrioInherit
	priority inheritance policy. More...

class	PrioNone
	no priority inheritance policy. More...

struct	QuestionRecord
	question record. More...

struct	QueueSegment
	queue memory segment. More...

struct	QueueSlotFull
	full queue slot used by MPSC/MPMC. More...

struct	QueueSlotLight
	lightweight queue slot used by SPSC. More...

struct	QueueSync
	queue synchronization primitives. More...

class	Raw
	RAW protocol class. More...

class	Rdtsc
	rdtsc clock policy (invariant TSC, CPU pinning, no NTP slewing). More...

class	Reactor
	Reactor class. More...

class	ReactorThread
	Convenience class that owns a Reactor running on a dedicated background thread. More...

class	RealTime
	real-time clock policy. More...

class	RecursiveMutex
	class used to protect shared data from being simultaneously accessed by multiple threads. More...

struct	ResourceRecord
	resource record. More...

class	Route
	class representing a single kernel routing table entry. More...

struct	RouteInfo
	route change notification payload. More...

struct	RouteKey
	key identifying a routing table entry. More...

class	RouteManager
	kernel routing table manager class. More...

struct	RouterAdvertisement
	router advertisement, RFC 4861 section 4.2. More...

struct	RouterSolicitation
	router solicitation, RFC 4861 section 4.1. More...

class	SaxCategory
	SAX API generic error category. More...

struct	SaxHandler
	SAX handler ignoring every event, to derive from and use through the derived type. More...

class	ScopedLock
	class owning a mutex for the duration of a scoped block. More...

class	ScopedStats
	RAII guard that automatically calls start() on construction and stop() on destruction. More...

class	Semaphore
	class used to protect shared data from being simultaneously accessed by multiple threads. More...

class	SharedCondition
	condition variable class for shared memory. More...

class	SharedMutex
	class used to protect shared data from being simultaneously accessed by multiple process via a shared memory. More...

class	SharedSemaphore
	class used to protect shared data from being simultaneously accessed by multiple process via a shared memory. More...

class	ShmMem
	posix shared memory provider. More...

class	Signature
	class used to manage signature. More...

class	Signaturebuf
	signature stream buffer. More...

union	SlabTaggedIndex
	tagged index. More...

class	Smtp
	SMTP protocol class (SMTP over TCP, upgradable to TLS using STARTTLS). More...

class	SmtpMessage
	mail message. More...

class	SmtpRecipient
	mail recipient. More...

class	Smtps
	SMTPS protocol class (SMTP over TLS). More...

class	SmtpSender
	mail sender. More...

class	SpinPolicy
	wheel run policy spinning on a dedicated thread. More...

struct	Spsc
	single producer single consumer ring buffer. More...

struct	SslCtxDelete
	custom functor for SSL context deletion. More...

struct	SslDelete
	custom functor for SSL handle deletion. More...

struct	StackOfGeneralNameDelete
	custom functor for STACK_OF(GENERAL_NAME) deletion. More...

struct	StackOfX509NameDelete
	Custom functor for STACK_OF(X509_NAME) deletion. More...

class	StreambufDecorator
	stream buffer decorator. More...

struct	SyncBinding
	queue forward declarations. More...

class	Tcp
	TCP protocol class. More...

class	Thread
	thread class. More...

class	ThreadPool
	thread pool class. More...

class	Tls
	TLS protocol class (TLS over TCP). More...

class	TlsCategory
	TLS error category. More...

class	TlsContext
	TLS/DTLS context. More...

class	TlsKey
	manage private and public keys. More...

class	Udp
	UDP protocol class. More...

class	UnixDgram
	unix datagram protocol class. More...

class	UnixStream
	unix stream protocol class. More...

class	Value
	value class. More...

class	ValueBuilder
	value builder class, filled by balanced SAX calls. More...

class	Variant
	variant class. More...

class	WorkerThread
	worker thread class. More...

class	Zstream
	zlib stream. More...

class	Zstreambuf
	zlib stream buffer. More...

Typedefs
template<class Protocol , class ProactorType >
using	AsyncOp
	asynchronous socket operation traits.

using	Futex = BasicFutex<PrioNone>

using	PiFutex = BasicFutex<PrioInherit>

using	SharedFutex = BasicSharedFutex<PrioNone>

using	SharedPiFutex = BasicSharedFutex<PrioInherit>

using	IpAddressList = std::vector<IpAddress>
	List of IP address.

using	Proactor = BasicProactor

using	ProactorThread = BasicProactorThread

template<typename T , typename... Ts>
using	match_t = typename std::invoke_result_t<overload<Ts...>, T>::type
	find a type that match one of the alternatives of a parameter pack.

using	BytesArray = std::vector<uint8_t>
	bytes array.

using	BigNumPtr = std::unique_ptr<BIGNUM, BigNumDelete>

using	EcdsaSigPtr = std::unique_ptr<ECDSA_SIG, EcdsaSigDelete>

using	EvpPkeyPtr = std::unique_ptr<EVP_PKEY, EvpPkeyDelete>

using	EvpPkeyCtxPtr = std::unique_ptr<EVP_PKEY_CTX, EvpPkeyCtxDelete>

using	EvpEncodeCtxPtr = std::unique_ptr<EVP_ENCODE_CTX, EvpEncodeCtxDelete>

using	EvpMdCtxPtr = std::unique_ptr<EVP_MD_CTX, EvpMdCtxDelete>

using	HmacCtxPtr = std::unique_ptr<HMAC_CTX, HmacCtxDelete>

using	StackOfX509NamePtr = std::unique_ptr<STACK_OF (X509_NAME), StackOfX509NameDelete>

using	StackOfGeneralNamePtr = std::unique_ptr<STACK_OF (GENERAL_NAME), StackOfGeneralNameDelete>

using	SslPtr = std::unique_ptr<SSL, SslDelete>

using	SslCtxPtr = std::shared_ptr<SSL_CTX>

using	DhKeyPtr = std::unique_ptr<DH, DhKeyDelete>

using	EcdhKeyPtr = std::unique_ptr<EC_KEY, EcdhKeyDelete>

using	JsonWriter = BasicJsonWriter<JsonWriteMode::None>
	JSON default writer.

using	JsonCanonicalizer = BasicJsonWriter<JsonWriteMode::Canonical>
	JSON canonicalizer, sorting object members when used with Value::serialize.

using	JsonReader = BasicJsonReader<JsonReadMode::None>
	JSON default reader.

using	Array = std::vector<Value>
	array.

using	Member = BasicMember<Value>
	object member.

using	Object = std::vector<Member>
	object.

using	ByteList = std::vector<uint8_t>
	list of bytes.

using	WordList = std::vector<uint16_t>
	list of 16 bits words.

using	IpList = std::vector<IpAddress>
	list of IP addresses.

using	DhcpOptionValue
	value carried by a DHCP option.

using	AliasList = std::unordered_set<std::string>
	list of aliases.

using	ServerList = std::unordered_set<std::string>
	list of name servers.

using	ExchangerList = std::unordered_set<std::string>
	list of mail exchangers.

using	InterfaceList = std::vector<Interface::Ptr>
	list of interfaces.

using	NeighborList = std::vector<Neighbor::Ptr>
	list of neighbors.

using	RouteList = std::vector<Route::Ptr>
	list of routes.

using	SmtpRecipients = std::vector<SmtpRecipient>
	mail recipient list.

Enumerations
enum class	Errc { InUse = 1 , InvalidParam , ConnectionRefused , ConnectionClosed , TimedOut , PermissionDenied , OutOfMemory , OperationFailed , NotFound , MessageUnknown , MessageTooLong , TemporaryError , UnknownError }
	Generic error codes. More...

enum class	DigestErrc { InvalidAlgorithm = 1 , InvalidKey , InvalidSignature }
	digest error codes. More...

enum class	TlsErrc { TlsCloseNotifyAlert = 1 , TlsProtocolError }
	TLS error codes. More...

enum class	JsonErrc { InvalidComment = 1 , InvalidEscaping , InvalidEncoding , IllegalCharacter , MissingCurlyBracket , MissingSquareBracket , MissingQuote , MissingColon , MissingComma , EndOfFile }
	JSON error codes. More...

enum class	JsonWriteMode { None , Canonical }
	JSON serialization mode. More...

enum	JsonReadMode { None = 0 , ParseComments = 1L << 0 , ValidateEncoding = 1L << 1 , StopParsingOnDone = 1L << 2 }
	JSON deserialization mode. More...

enum class	SaxErrc { StackOverflow = 1 , InvalidParent , InvalidKey , InvalidValue , ExtraData , Truncated }
	SAX API generic error codes. More...

enum class	InterfaceChangeType : uint32_t { Added = 1L << 0 , Deleted = 1L << 1 , Modified = 1L << 2 , AdminStateChanged = 1L << 3 , OperStateChanged = 1L << 4 , MacChanged = 1L << 5 , NameChanged = 1L << 6 , MtuChanged = 1L << 7 , KindChanged = 1L << 8 , MasterChanged = 1L << 9 }
	enumeration of interface change type. More...

enum class	NeighborChangeType : uint32_t { Added = 1L << 0 , Deleted = 1L << 1 , Modified = 1L << 2 , MacChanged = 1L << 3 , StateChanged = 1L << 4 }
	enumeration of neighbor change types. More...

enum class	RouteChangeType : uint32_t { Added = 1L << 0 , Deleted = 1L << 1 , Modified = 1L << 2 , GatewayChanged = 1L << 3 , MetricChanged = 1L << 4 , TypeChanged = 1L << 5 , ScopeChanged = 1L << 6 , ProtocolChanged = 1L << 7 }
	enumeration of route change types. More...

enum class	HttpErrc { BadRequest = 1 , Unauthorized , Forbidden , NotFound , Unsupported , LengthRequired , PayloadTooLarge , UriTooLong , HeaderTooLarge , ServerError , NotImplemented , BadGateway }
	HTTP API generic error codes. More...

enum	HttpMethod : int { Head = 1L << 0 , Get = 1L << 1 , Put = 1L << 2 , Post = 1L << 3 , Delete = 1L << 4 }
	enumeration of HTTP methods. More...

enum	HttpContentType { Root , Alias , Exec , Redirect }
	HTTP content Type. More...

Functions
template<class Protocol >
bool	operator== (const BasicLinkLayerEndpoint< Protocol > &a, const BasicLinkLayerEndpoint< Protocol > &b) noexcept
	compare if endpoints are equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicLinkLayerEndpoint< Protocol > &a, const BasicLinkLayerEndpoint< Protocol > &b) noexcept
	three-way compare endpoints.

template<class Protocol >
std::ostream &	operator<< (std::ostream &os, const BasicLinkLayerEndpoint< Protocol > &endpoint)
	push endpoint representation into a stream.

template<class Protocol >
bool	operator== (const BasicUnixEndpoint< Protocol > &a, const BasicUnixEndpoint< Protocol > &b) noexcept
	compare if endpoints are equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicUnixEndpoint< Protocol > &a, const BasicUnixEndpoint< Protocol > &b) noexcept
	three-way compare endpoints.

template<class Protocol >
std::ostream &	operator<< (std::ostream &os, const BasicUnixEndpoint< Protocol > &endpoint)
	push endpoint representation into a stream.

template<class Protocol >
bool	operator== (const BasicInternetEndpoint< Protocol > &a, const BasicInternetEndpoint< Protocol > &b) noexcept
	compare if equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicInternetEndpoint< Protocol > &a, const BasicInternetEndpoint< Protocol > &b) noexcept
	three-way compare endpoints.

template<class Protocol >
std::ostream &	operator<< (std::ostream &os, const BasicInternetEndpoint< Protocol > &endpoint)
	push endpoint representation into a stream.

const std::error_category &	getErrorCategory () noexcept
	Get error category.

std::error_code	make_error_code (join::Errc code) noexcept
	Create an std::error_code object.

std::error_condition	make_error_condition (join::Errc code) noexcept
	Create an std::error_condition object.

std::string	base (const std::string &filepath)
	get base path of the specified file.

std::string	filename (const std::string &filepath)
	get file name of the specified file.

std::string	extension (const std::string &filepath)
	get extension of the file specified.

std::string	mime (const std::string &filepath)
	get mime type of the specified file.

bool	exists (const std::string &filepath)
	check if the file specified exists.

bool	operator== (const IpAddress &a, const IpAddress &b)
	compare if two IP address are equals.

std::strong_ordering	operator<=> (const IpAddress &a, const IpAddress &b)
	three-way compare IP addresses.

IpAddress	operator& (const IpAddress &a, const IpAddress &b)
	perform AND operation on IP address.

IpAddress	operator\| (const IpAddress &a, const IpAddress &b)
	perform OR operation on IP address.

IpAddress	operator^ (const IpAddress &a, const IpAddress &b)
	perform XOR operation on IP address.

std::ostream &	operator<< (std::ostream &out, const IpAddress &address)
	insert address into stream.

MacAddress	operator+ (int value, const MacAddress &a)
	add the provided value to the provided MAC address.

MacAddress	operator+ (const MacAddress &a, int value)
	add the provided value to the provided MAC address.

bool	operator== (const MacAddress &a, const MacAddress &b)
	compare if two MAC address are equals.

std::strong_ordering	operator<=> (const MacAddress &a, const MacAddress &b)
	three-way compare MAC addresses.

MacAddress	operator& (const MacAddress &a, const MacAddress &b)
	perform AND operation on MAC address.

MacAddress	operator\| (const MacAddress &a, const MacAddress &b)
	perform OR operation on MAC address.

MacAddress	operator^ (const MacAddress &a, const MacAddress &b)
	perform XOR operation on MAC address.

std::ostream &	operator<< (std::ostream &out, const MacAddress &a)
	insert MAC address into stream.

uint64_t	pageSize () noexcept
	get the system page size.

uint64_t	hugePageSize () noexcept
	get the default huge page size.

int	mlock (void *ptr, size_t size) noexcept
	lock memory in RAM.

constexpr bool	operator== (const Udp &a, const Udp &b) noexcept
	check if equals.

constexpr bool	operator== (const Icmp &a, const Icmp &b) noexcept
	check if equal.

constexpr bool	operator== (const Tcp &a, const Tcp &b) noexcept
	check if equals.

template<class Protocol >
bool	operator== (const BasicSocket< Protocol > &a, const BasicSocket< Protocol > &b) noexcept
	compare if socket handles are equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicSocket< Protocol > &a, const BasicSocket< Protocol > &b) noexcept
	three-way compare socket handles.

std::ostream &	statsHeader (std::ostream &out)
	print the statistics table header to a stream.

std::ostream &	nsec (std::ostream &out)
	set latency display unit to nanoseconds.

std::ostream &	usec (std::ostream &out)
	set latency display unit to microseconds.

std::ostream &	msec (std::ostream &out)
	set latency display unit to milliseconds.

std::ostream &	sec (std::ostream &out)
	set latency display unit to seconds.

std::ostream &	ops (std::ostream &out)
	set throughput display unit to ops/sec.

std::ostream &	kops (std::ostream &out)
	set throughput display unit to Kops/sec.

std::ostream &	mops (std::ostream &out)
	set throughput display unit to Mops/sec.

std::ostream &	gops (std::ostream &out)
	set throughput display unit to Gops/sec.

template<class ClockPolicy >
std::ostream &	operator<< (std::ostream &out, const BasicStats< ClockPolicy > &statistics)
	stream insertion operator for statistics.

template<class InputIt , class Func >
void	distribute (InputIt first, InputIt last, Func function)
	determine the number of threads and tasks per thread to run and execute them in parallel.

template<class InputIt , class Func >
void	parallelForEach (InputIt first, InputIt last, Func function)
	parallel for each loop.

template<typename Exception , typename... Args>
	__attribute__ ((cold, noinline)) void throwException(Args &&... args)
	throw an exception out of the hot path.

template<class Type > requires (std::is_arithmetic_v<Type> && sizeof (Type) <= sizeof (uint64_t))
Type &	swap (Type &val)
	swaps byte orders.

bool	compareNoCase (const std::string &a, const std::string &b)
	case insensitive string comparison.

std::string &	trimLeft (std::string &s)
	trim left.

std::string &	trimRight (std::string &s)
	trim right.

std::string &	trim (std::string &s)
	trim.

std::string &	replaceAll (std::string &str, const std::string &toReplace, const std::string &by)
	replace all occurrences of a substring.

std::vector< std::string >	split (const std::string &in, const std::string &delim)
	split a string using a delimiter.

std::vector< std::string >	rsplit (const std::string &in, const std::string &delim)
	split a string in reverse order using a delimiter.

bool	getline (std::istream &in, std::string &line, std::streamsize max=1024)
	read line (delimiter "\r\n").

bool	getline (std::streambuf &in, std::string &line, std::streamsize max=1024)
	read line (delimiter "\r\n").

bool	readBytes (const char &cur, const char end, void *out, size_t size) noexcept
	read bytes from a buffer.

bool	writeBytes (char &cur, const char end, const void *in, size_t size) noexcept
	write bytes to a buffer.

uint16_t	checksum (const uint16_t *data, size_t len, uint16_t current=0) noexcept
	get standard 1s complement checksum.

void	dump (const void *data, unsigned long size, std::ostream &out=std::cout)
	dump data to standard output stream.

template<typename Type >
Type	randomize ()
	create a random number.

template<class Func , class... Args>
std::chrono::milliseconds	benchmark (Func &&func, Args &&... args)
	benchmark function call.

template<typename Clock , typename Duration >
struct timespec	toTimespec (std::chrono::time_point< Clock, Duration > timePoint)
	converts time_point to timespec.

template<typename Rep , typename Period >
struct timespec	toTimespec (std::chrono::duration< Rep, Period > duration)
	converts duration to timespec.

constexpr bool	isPow2 (uint64_t value) noexcept
	check if a value is a power of two.

constexpr uint64_t	nextPow2 (uint64_t value) noexcept
	round up to the next power of two.

template<typename... Ts>
constexpr bool	operator== (const Variant< Ts... > &lhs, const Variant< Ts... > &rhs)
	compare if equal.

template<typename... Ts>
constexpr details::VariantOrdering< Ts... >	operator<=> (const Variant< Ts... > &lhs, const Variant< Ts... > &rhs)
	three-way compare variants.

template<typename... Ts>
void	swap (Variant< Ts... > &lhs, Variant< Ts... > &rhs) noexcept
	swap two variants.

template<typename Type >
class	__attribute__ ((packed)) View
	non-owning contiguous sequence of elements.

template<typename Type >
constexpr bool	operator== (const View< Type > &lhs, const View< Type > &rhs)
	compare views.

template<typename Type >
constexpr std::partial_ordering	operator<=> (const View< Type > &lhs, const View< Type > &rhs)
	three-way compare views.

template<typename Type > requires std::same_as<std::remove_const_t<Type>, char>
constexpr bool	operator== (const View< Type > &lhs, const View< Type > &rhs)
	compare character views.

template<typename Type > requires std::same_as<std::remove_const_t<Type>, char>
constexpr std::partial_ordering	operator<=> (const View< Type > &lhs, const View< Type > &rhs)
	three-way compare character views.

std::string	bin2hex (const BytesArray &bin)
	convert bytes array to string.

const std::error_category &	getDigestCategory ()
	get error category.

std::error_code	make_error_code (DigestErrc code)
	create an std::error_code object.

std::error_condition	make_error_condition (DigestErrc code)
	create an std::error_condition object.

void	initializeOpenSSL ()
	initialize the OpenSSL libraries.

template<class Protocol >
bool	operator== (const BasicTls< Protocol > &a, const BasicTls< Protocol > &b) noexcept
	compare if TLS decorators are equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicTls< Protocol > &a, const BasicTls< Protocol > &b) noexcept
	three-way compare TLS decorators.

const std::error_category &	getTlsCategory ()
	get error category.

std::error_code	make_error_code (TlsErrc code)
	create an std::error_code object.

std::error_condition	make_error_condition (TlsErrc code)
	create an std::error_condition object.

constexpr bool	operator== (const Tls &a, const Tls &b) noexcept
	check if equals.

constexpr bool	operator== (const Dtls &a, const Dtls &b) noexcept
	check if equals.

const std::error_category &	jsonCategory () noexcept
	get error category.

std::error_code	make_error_code (JsonErrc code) noexcept
	create an std::error_code object.

std::error_condition	make_error_condition (JsonErrc code) noexcept
	create an std::error_condition object.

constexpr JsonReadMode	operator& (JsonReadMode a, JsonReadMode b) noexcept
	perform binary AND on JsonReadMode.

constexpr JsonReadMode	operator\| (JsonReadMode a, JsonReadMode b) noexcept
	perform binary OR on JsonReadMode.

constexpr const JsonReadMode &	operator&= (JsonReadMode &a, JsonReadMode b) noexcept
	perform binary AND on JsonReadMode.

constexpr const JsonReadMode &	operator\|= (JsonReadMode &a, JsonReadMode b) noexcept
	perform binary OR on JsonReadMode.

const std::error_category &	saxCategory () noexcept
	get error category.

std::error_code	make_error_code (SaxErrc code) noexcept
	create an std::error_code object.

std::error_condition	make_error_condition (SaxErrc code) noexcept
	create an std::error_condition object.

constexpr bool	operator== (const Value &lhs, const Value &rhs)
	compare if equal.

constexpr std::partial_ordering	operator<=> (const Value &lhs, const Value &rhs)
	three-way compare values.

bool	operator== (const DhcpOption &lhs, const DhcpOption &rhs)
	compare if equal.

std::weak_ordering	operator<=> (const DhcpOption &lhs, const DhcpOption &rhs)
	three-way compare options.

std::ostream &	operator<< (std::ostream &out, const DhcpOption &options)
	insert options into stream.

constexpr bool	operator== (const Dhcp &a, const Dhcp &b) noexcept
	check if equals.

constexpr bool	operator== (const Dns &a, const Dns &b) noexcept
	check if equals.

constexpr bool	operator== (const Dot &a, const Dot &b) noexcept
	check if equals.

bool	operator== (const Interface::Ptr &lhs, const Interface::Ptr &rhs)
	compare if two interfaces are equal.

std::strong_ordering	operator<=> (const Interface::Ptr &lhs, const Interface::Ptr &rhs)
	three-way compare interfaces.

InterfaceChangeType	operator& (InterfaceChangeType a, InterfaceChangeType b)
	perform binary AND on InterfaceChangeType.

InterfaceChangeType	operator\| (InterfaceChangeType a, InterfaceChangeType b)
	perform binary OR on InterfaceChangeType.

InterfaceChangeType	operator^ (InterfaceChangeType a, InterfaceChangeType b)
	perform binary XOR on InterfaceChangeType.

InterfaceChangeType	operator~ (InterfaceChangeType a)
	perform binary NOT on InterfaceChangeType.

const InterfaceChangeType &	operator&= (InterfaceChangeType &a, InterfaceChangeType b)
	perform binary AND assignment on InterfaceChangeType.

const InterfaceChangeType &	operator\|= (InterfaceChangeType &a, InterfaceChangeType b)
	perform binary OR assignment on InterfaceChangeType.

const InterfaceChangeType &	operator^= (InterfaceChangeType &a, InterfaceChangeType b)
	perform binary XOR assignment on InterfaceChangeType.

constexpr bool	operator== (const Mdns &a, const Mdns &b) noexcept
	check if equals.

constexpr bool	operator== (const Ndp &a, const Ndp &b) noexcept
	check if equals.

bool	operator== (const NeighborKey &lhs, const NeighborKey &rhs) noexcept
	compare if two neighbor keys are equal.

std::strong_ordering	operator<=> (const NeighborKey &lhs, const NeighborKey &rhs) noexcept
	three-way compare neighbor keys.

bool	operator== (const Neighbor::Ptr &lhs, const Neighbor::Ptr &rhs)
	compare if two neighbor are equal.

std::strong_ordering	operator<=> (const Neighbor::Ptr &lhs, const Neighbor::Ptr &rhs)
	three-way compare neighbors.

NeighborChangeType	operator& (NeighborChangeType a, NeighborChangeType b)
	perform binary AND on NeighborChangeType.

NeighborChangeType	operator\| (NeighborChangeType a, NeighborChangeType b)
	perform binary OR on NeighborChangeType.

NeighborChangeType	operator^ (NeighborChangeType a, NeighborChangeType b)
	perform binary XOR on NeighborChangeType.

NeighborChangeType	operator~ (NeighborChangeType a)
	perform binary NOT on NeighborChangeType.

const NeighborChangeType &	operator&= (NeighborChangeType &a, NeighborChangeType b)
	perform binary AND on NeighborChangeType.

const NeighborChangeType &	operator\|= (NeighborChangeType &a, NeighborChangeType b)
	perform binary OR on NeighborChangeType.

const NeighborChangeType &	operator^= (NeighborChangeType &a, NeighborChangeType b)
	perform binary XOR on NeighborChangeType.

template<class Protocol >
bool	operator== (const BasicNetlinkEndpoint< Protocol > &a, const BasicNetlinkEndpoint< Protocol > &b) noexcept
	compare if endpoints are equal.

template<class Protocol >
std::strong_ordering	operator<=> (const BasicNetlinkEndpoint< Protocol > &a, const BasicNetlinkEndpoint< Protocol > &b) noexcept
	three-way compare endpoints.

template<class Protocol >
std::ostream &	operator<< (std::ostream &os, const BasicNetlinkEndpoint< Protocol > &endpoint)
	push endpoint representation into a stream.

constexpr bool	operator== (const Netlink &a, const Netlink &b) noexcept
	check if equals.

bool	operator== (const RouteKey &lhs, const RouteKey &rhs) noexcept
	compare if two route keys are equal.

std::strong_ordering	operator<=> (const RouteKey &lhs, const RouteKey &rhs) noexcept
	three-way compare route keys.

bool	operator== (const Route::Ptr &lhs, const Route::Ptr &rhs)
	compare if two routes are equal.

std::strong_ordering	operator<=> (const Route::Ptr &lhs, const Route::Ptr &rhs)
	three-way compare routes.

RouteChangeType	operator& (RouteChangeType a, RouteChangeType b)
	perform binary AND on RouteChangeType.

RouteChangeType	operator\| (RouteChangeType a, RouteChangeType b)
	perform binary OR on RouteChangeType.

RouteChangeType	operator^ (RouteChangeType a, RouteChangeType b)
	perform binary XOR on RouteChangeType.

RouteChangeType	operator~ (RouteChangeType a)
	perform binary NOT on RouteChangeType.

const RouteChangeType &	operator&= (RouteChangeType &a, RouteChangeType b)
	perform binary AND assignment on RouteChangeType.

const RouteChangeType &	operator\|= (RouteChangeType &a, RouteChangeType b)
	perform binary OR assignment on RouteChangeType.

const RouteChangeType &	operator^= (RouteChangeType &a, RouteChangeType b)
	perform binary XOR assignment on RouteChangeType.

template<class Protocol >
constexpr BasicHttpClient< Protocol > &	operator<< (BasicHttpClient< Protocol > &out, HttpRequest &request)
	write HTTP request to the HTTP stream.

template<class Protocol >
constexpr BasicHttpClient< Protocol > &	operator>> (BasicHttpClient< Protocol > &in, HttpResponse &response)
	read HTTP response from the HTTP stream.

template<class Protocol >
constexpr BasicHttpSecureClient< Protocol > &	operator<< (BasicHttpSecureClient< Protocol > &out, HttpRequest &request)
	write request to the HTTPS stream.

template<class Protocol >
constexpr BasicHttpSecureClient< Protocol > &	operator>> (BasicHttpSecureClient< Protocol > &in, HttpResponse &response)
	read response from the HTTPS stream.

const std::error_category &	httpCategory ()
	get error category.

std::error_code	make_error_code (HttpErrc code)
	create an std::error_code object.

std::error_condition	make_error_condition (HttpErrc code)
	create an std::error_condition object.

HttpMethod	operator& (HttpMethod __a, HttpMethod __b)
	perform binary AND on HttpMethod.

HttpMethod	operator\| (HttpMethod __a, HttpMethod __b)
	perform binary OR on HttpMethod.

HttpMethod	operator^ (HttpMethod __a, HttpMethod __b)
	perform binary XOR on HttpMethod.

HttpMethod	operator~ (HttpMethod __a)
	perform binary NOT on HttpMethod.

const HttpMethod &	operator&= (HttpMethod &__a, HttpMethod __b)
	perform binary AND on HttpMethod.

const HttpMethod &	operator\|= (HttpMethod &__a, HttpMethod __b)
	perform binary OR on HttpMethod.

const HttpMethod &	operator^= (HttpMethod &__a, HttpMethod __b)
	perform binary XOR on HttpMethod.

constexpr bool	operator== (const Http &a, const Http &b) noexcept
	check if equals.

constexpr bool	operator== (const Https &a, const Https &b) noexcept
	check if equals.

std::ostream &	operator<< (std::ostream &out, const SmtpSender &sender)
	insert mail sender into stream.

constexpr bool	operator== (const Smtp &a, const Smtp &b) noexcept
	check if equals.

constexpr bool	operator== (const Smtps &a, const Smtps &b) noexcept
	check if equals.

Variables
thread_local std::error_code	lastError
	last error.

template<typename T >
constexpr bool	has_sqpoll_v = (T::flags & IORING_SETUP_SQPOLL) != 0

template<typename T >
constexpr bool	has_cq_entries_v = requires { T::cqEntries; }

template<typename T >
constexpr bool	has_sq_thread_idle_v = requires { T::sqThreadIdle; }

template<typename T >
constexpr bool	has_sq_thread_cpu_v = requires { T::sqThreadCpu; }

template<typename T >
constexpr bool	has_spin_v = requires { T::spinNs; }

template<typename T >
constexpr bool	is_default_v = !has_spin_v<T> && !has_sqpoll_v<T>

template<typename T >
constexpr uint64_t	spin_ns_v = 10'000

template<typename T >
constexpr uint64_t	spin_ns_v< T > = T::spinNs

template<typename T >
constexpr bool	has_yield_ns_v = requires { T::yieldNs; }

template<typename T >
constexpr uint64_t	yield_ns_v = 100'000

template<typename T >
constexpr uint64_t	yield_ns_v< T > = T::yieldNs

template<typename T >
constexpr bool	has_sleep_ns_v = requires { T::sleepNs; }

template<typename T >
constexpr uint64_t	sleep_ns_v = 0

template<typename T >
constexpr uint64_t	sleep_ns_v< T > = T::sleepNs

template<typename T >
constexpr bool	has_tick_ns_v = requires { T::tickNs; }

template<typename T >
constexpr uint64_t	tick_ns_v = 1'000

template<typename T >
constexpr uint64_t	tick_ns_v< T > = T::tickNs

template<typename SyncPolicy >
constexpr bool	needs_seq_v = true
	primary trait: all sync policies need sequence numbers by default.

template<typename Type , typename Backend >
constexpr bool	needs_seq_v< Spsc< Type, Backend > > = false
	specialization for SPSC: no sequence number needed.

template<typename T , typename... Ts>
constexpr std::size_t	find_index_v = 0
	get element position in a parameter pack according its type.

template<typename T , typename First , typename... Ts>
constexpr std::size_t	find_index_v< T, First, Ts... >
	get element position in a parameter pack according its type.

template<typename T , typename... Ts>
constexpr std::size_t	count_v = (std::size_t{0} + ... + std::is_same_v<T, Ts>)
	count the number of time a type appears in a parameter pack.

template<typename T , typename... Ts>
constexpr bool	is_unique_v = count_v<T, Ts...> == 1
	check if a type only appears one time in a parameter pack.

const std::string	defaultCipher

const std::string	defaultCipher_1_3

constexpr size_t	saxMaxDepth = 256
	max number of nested containers.

Detailed Description

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

◆ AliasList

using join::AliasList = std::unordered_set<std::string>

list of aliases.

◆ Array

using join::Array = std::vector<Value>

array.

◆ AsyncOp

template<class Protocol , class ProactorType >

using join::AsyncOp

Initial value:

BasicAsyncOpTraits<BasicAsyncWait<Protocol, ProactorType>, BasicAsyncRead<Protocol, ProactorType>,

BasicAsyncWrite<Protocol, ProactorType>>

asynchronous socket operation traits.

◆ BigNumPtr

using join::BigNumPtr = std::unique_ptr<BIGNUM, BigNumDelete>

◆ ByteList

using join::ByteList = std::vector<uint8_t>

list of bytes.

◆ BytesArray

using join::BytesArray = std::vector<uint8_t>

bytes array.

◆ DhcpOptionValue

using join::DhcpOptionValue

Initial value:

Variant<uint8_t, uint16_t, uint32_t, int32_t, std::string, IpAddress, MacAddress, ByteList, WordList, IpList>

value carried by a DHCP option.

◆ DhKeyPtr

using join::DhKeyPtr = std::unique_ptr<DH, DhKeyDelete>

◆ EcdhKeyPtr

using join::EcdhKeyPtr = std::unique_ptr<EC_KEY, EcdhKeyDelete>

◆ EcdsaSigPtr

using join::EcdsaSigPtr = std::unique_ptr<ECDSA_SIG, EcdsaSigDelete>

◆ EvpEncodeCtxPtr

using join::EvpEncodeCtxPtr = std::unique_ptr<EVP_ENCODE_CTX, EvpEncodeCtxDelete>

◆ EvpMdCtxPtr

using join::EvpMdCtxPtr = std::unique_ptr<EVP_MD_CTX, EvpMdCtxDelete>

◆ EvpPkeyCtxPtr

using join::EvpPkeyCtxPtr = std::unique_ptr<EVP_PKEY_CTX, EvpPkeyCtxDelete>

◆ EvpPkeyPtr

using join::EvpPkeyPtr = std::unique_ptr<EVP_PKEY, EvpPkeyDelete>

◆ ExchangerList

using join::ExchangerList = std::unordered_set<std::string>

list of mail exchangers.

◆ Futex

using join::Futex = BasicFutex<PrioNone>

◆ HmacCtxPtr

using join::HmacCtxPtr = std::unique_ptr<HMAC_CTX, HmacCtxDelete>

◆ InterfaceList

using join::InterfaceList = std::vector<Interface::Ptr>

list of interfaces.

◆ IpAddressList

using join::IpAddressList = std::vector<IpAddress>

List of IP address.

◆ IpList

using join::IpList = std::vector<IpAddress>

list of IP addresses.

◆ JsonCanonicalizer

using join::JsonCanonicalizer = BasicJsonWriter<JsonWriteMode::Canonical>

JSON canonicalizer, sorting object members when used with Value::serialize.

◆ JsonReader

using join::JsonReader = BasicJsonReader<JsonReadMode::None>

JSON default reader.

◆ JsonWriter

using join::JsonWriter = BasicJsonWriter<JsonWriteMode::None>

JSON default writer.

◆ match_t

template<typename T , typename... Ts>

using join::match_t = typename std::invoke_result_t<overload<Ts...>, T>::type

find a type that match one of the alternatives of a parameter pack.

◆ Member

using join::Member = BasicMember<Value>

object member.

◆ NeighborList

using join::NeighborList = std::vector<Neighbor::Ptr>

list of neighbors.

◆ Object

using join::Object = std::vector<Member>

object.

◆ PiFutex

using join::PiFutex = BasicFutex<PrioInherit>

◆ Proactor

using join::Proactor = BasicProactor

◆ ProactorThread

using join::ProactorThread = BasicProactorThread

◆ RouteList

using join::RouteList = std::vector<Route::Ptr>

list of routes.

◆ ServerList

using join::ServerList = std::unordered_set<std::string>

list of name servers.

◆ SharedFutex

using join::SharedFutex = BasicSharedFutex<PrioNone>

◆ SharedPiFutex

using join::SharedPiFutex = BasicSharedFutex<PrioInherit>

◆ SmtpRecipients

using join::SmtpRecipients = std::vector<SmtpRecipient>

mail recipient list.

◆ SslCtxPtr

using join::SslCtxPtr = std::shared_ptr<SSL_CTX>

◆ SslPtr

using join::SslPtr = std::unique_ptr<SSL, SslDelete>

◆ StackOfGeneralNamePtr

using join::StackOfGeneralNamePtr = std::unique_ptr<STACK_OF (GENERAL_NAME), StackOfGeneralNameDelete>

◆ StackOfX509NamePtr

using join::StackOfX509NamePtr = std::unique_ptr<STACK_OF (X509_NAME), StackOfX509NameDelete>

◆ WordList

using join::WordList = std::vector<uint16_t>

list of 16 bits words.

Enumeration Type Documentation

◆ DigestErrc

enum class join::DigestErrc

strong

digest error codes.

Enumerator
InvalidAlgorithm	invalid algorithm.
InvalidKey	invalid key.
InvalidSignature	invalid signature.

◆ Errc

enum class join::Errc

strong

Generic error codes.

Enumerator
InUse	Already in use.
InvalidParam	Invalid parameters were used.
ConnectionRefused	The connection was refused.
ConnectionClosed	The connection was closed by the peer.
TimedOut	The operation timed out.
PermissionDenied	The operation was not permitted.
OutOfMemory	The operation run out of memory.
OperationFailed	The operation failed.
NotFound	Resource not found.
MessageUnknown	Message unknown.
MessageTooLong	Message too long.
TemporaryError	A temporary error occurred, operation should be performed again later.
UnknownError	An unknown error occurred.

◆ HttpContentType

enum join::HttpContentType

HTTP content Type.

Enumerator
Root	Content appended to root directory.
Alias	Content replaced by alias.
Exec	Executable content.
Redirect	Redirection.

◆ HttpErrc

enum class join::HttpErrc

strong

HTTP API generic error codes.

Enumerator
BadRequest	malformed request syntax.
Unauthorized	authentication is required.
Forbidden	missing required permissions.
NotFound	resource could not be found.
Unsupported	method is not supported.
LengthRequired	length was not specified.
PayloadTooLarge	request payload is too large.
UriTooLong	request URI is too long.
HeaderTooLarge	request header is too large.
ServerError	generic error.
NotImplemented	not implemented.
BadGateway	invalid response from the upstream server.

◆ HttpMethod

enum join::HttpMethod : int

enumeration of HTTP methods.

Enumerator
Head	retrieve informations identified by the Request-URI without message-body.
Get	retrieve informations identified by the Request-URI.
Put	request that the enclosed entity be stored under the supplied Request-URI.
Post	request that the enclosed entity is accepted as a new subordinate of the resource identified by the Request-URI.
Delete	request that the server delete the resource identified by the Request-URI.

◆ InterfaceChangeType

enum class join::InterfaceChangeType : uint32_t

strong

enumeration of interface change type.

Enumerator
Added	interface did not exist before.
Deleted	interface was removed.
Modified	interface was updated.
AdminStateChanged	interface admin status was updated.
OperStateChanged	interface operational status was updated.
MacChanged	interface MAC address changed.
NameChanged	interface name changed.
MtuChanged	interface MTU changed.
KindChanged	interface kind changed.
MasterChanged	interface master bridge changed.

◆ JsonErrc

enum class join::JsonErrc

strong

JSON error codes.

Enumerator
InvalidComment	comment is invalid.
InvalidEscaping	character escaping is invalid.
InvalidEncoding	character encoding is invalid.
IllegalCharacter	illegal character.
MissingCurlyBracket	missing curly bracket.
MissingSquareBracket	missing square bracket.
MissingQuote	missing quote.
MissingColon	missing colon.
MissingComma	missing comma.
EndOfFile	end of file.

◆ JsonReadMode

enum join::JsonReadMode

JSON deserialization mode.

Enumerator
None	no read mode set.
ParseComments	parse comments.
ValidateEncoding	validate UTF-8 encoding of strings.
StopParsingOnDone	stop parsing on done.

◆ JsonWriteMode

enum class join::JsonWriteMode

strong

JSON serialization mode.

Enumerator
None	no write mode set.
Canonical	canonical form.

◆ NeighborChangeType

enum class join::NeighborChangeType : uint32_t

strong

enumeration of neighbor change types.

Enumerator
Added	entry did not exist before.
Deleted	entry was removed.
Modified	entry was updated.
MacChanged	MAC address changed.
StateChanged	NUD state changed.

◆ RouteChangeType

enum class join::RouteChangeType : uint32_t

strong

enumeration of route change types.

Enumerator
Added	entry did not exist before.
Deleted	entry was removed.
Modified	entry was updated.
GatewayChanged	gateway address changed.
MetricChanged	metric changed.
TypeChanged	type changed.
ScopeChanged	scope changed.
ProtocolChanged	protocol changed.

◆ SaxErrc

enum class join::SaxErrc

strong

SAX API generic error codes.

Enumerator
StackOverflow	Stack overflow.
InvalidParent	Parent not an array nor an object.
InvalidKey	Key is invalid.
InvalidValue	Value is invalid.
ExtraData	Extra data detected.
Truncated	Data is truncated.

◆ TlsErrc

enum class join::TlsErrc

strong

TLS error codes.

Enumerator
TlsCloseNotifyAlert	A close notify alert was received.
TlsProtocolError	A failure in the TLS library occurred, usually a protocol error.

Function Documentation

◆ attribute() [1/2]

template<typename Exception , typename... Args>

join::__attribute__ ( (cold, noinline) ) &&

throw an exception out of the hot path.

Parameters

args	exception constructor arguments.

◆ attribute() [2/2]

template<typename Type >

class join::__attribute__ ( (packed) )

non-owning contiguous sequence of elements.

create an empty view.

create a view.

Parameters

data	first element.
size	number of elements, must fit in 32 bits.

get the first element.

Returns: pointer to the first element.

get the number of elements.

Returns: number of elements.

check if the view is empty.

Returns: true if empty.

get an iterator to the first element.

Returns: iterator to the first element.

get an iterator past the last element.

Returns: iterator past the last element.

access an element.

Parameters

pos	element position.

Returns: element.

first element.

number of elements.

◆ base()

std::string join::base ( const std::string & filepath )

inline

get base path of the specified file.

Parameters

filepath path to parse.

Returns: base path of the specified file.

◆ benchmark()

template<class Func , class... Args>

std::chrono::milliseconds join::benchmark	(	Func &&	func,
		Args &&...	args )

benchmark function call.

Parameters

function	function to benchmark.
arguments	function arguments.

Returns: time elapsed in milliseconds.

◆ bin2hex()

std::string join::bin2hex ( const BytesArray & bin )

inline

convert bytes array to string.

Parameters

bin	bytes array.

Returns: converted bytes array string.

◆ checksum()

uint16_t join::checksum	(	const uint16_t *	data,
		size_t	len,
		uint16_t	current = 0 )

inlinenoexcept

get standard 1s complement checksum.

Parameters

data	data pointer.
len	data len.
current	current sum.

Returns: checksum.

◆ compareNoCase()

bool join::compareNoCase	(	const std::string &	a,
		const std::string &	b )

inline

case insensitive string comparison.

Parameters

a	string to compare.
b	string to compare to.

Returns: true if equals, false otharwise.

◆ distribute()

template<class InputIt , class Func >

void join::distribute	(	InputIt	first,
		InputIt	last,
		Func	function )

determine the number of threads and tasks per thread to run and execute them in parallel.

Parameters

first	first iterator.
last	last iterator.
function	function to execute in parallel.

◆ dump()

void join::dump	(	const void *	data,
		unsigned long	size,
		std::ostream &	out = std::cout )

inline

dump data to standard output stream.

Parameters

data	data to dump.
size	number of data bytes.

◆ exists()

bool join::exists ( const std::string & filepath )

inline

check if the file specified exists.

Parameters

filepath Path to the file to examine.

Returns: true if file exists, false otherwise.

◆ extension()

std::string join::extension ( const std::string & filepath )

inline

get extension of the file specified.

Parameters

filepath path to parse.

Returns: The extension of the specified file.

◆ filename()

std::string join::filename ( const std::string & filepath )

inline

get file name of the specified file.

Parameters

filepath path to parse.

Returns: The file name of the specified file.

◆ getDigestCategory()

const std::error_category & join::getDigestCategory ( )

get error category.

Returns: the created std::error_category object.

◆ getErrorCategory()

const std::error_category & join::getErrorCategory ( )

noexcept

Get error category.

Returns: the created std::error_category object.

◆ getline() [1/2]

bool join::getline	(	std::istream &	in,
		std::string &	line,
		std::streamsize	max = 1024 )

inline

read line (delimiter "\r\n").

Parameters

in	input stream.
line	line read.
max	max characters to read.

Returns: true on success, false on error.

◆ getline() [2/2]

bool join::getline	(	std::streambuf &	in,
		std::string &	line,
		std::streamsize	max = 1024 )

inline

read line (delimiter "\r\n").

Parameters

in	input stream buffer.
line	line read.
max	max characters to read.

Returns: true on success, false on error.

◆ getTlsCategory()

const std::error_category & join::getTlsCategory ( )

get error category.

Returns: the created std::error_category object.

◆ gops()

std::ostream & join::gops ( std::ostream & out )

inline

set throughput display unit to Gops/sec.

Parameters

out	output stream.

Returns: reference to out.

◆ httpCategory()

const std::error_category & join::httpCategory ( )

get error category.

Returns: the created std::error_category object.

◆ hugePageSize()

uint64_t join::hugePageSize ( )

inlinenoexcept

get the default huge page size.

Returns: the huge page size in bytes, 0 if huge pages are not supported.

◆ initializeOpenSSL()

void join::initializeOpenSSL ( )

initialize the OpenSSL libraries.

Note: the OpenSSL library should be initialized only once and at the early beginning of the process. this function will ensure that the libraries initialization can't be done multiple times even if called in multiple places.

◆ isPow2()

bool join::isPow2 ( uint64_t value )

constexprnoexcept

check if a value is a power of two.

Parameters

value value to check.

Returns: true if the value is a power of two, false otherwise.

◆ jsonCategory()

const std::error_category & join::jsonCategory ( )

noexcept

get error category.

Returns: the created std::error_category object.

◆ kops()

std::ostream & join::kops ( std::ostream & out )

inline

set throughput display unit to Kops/sec.

Parameters

out	output stream.

Returns: reference to out.

◆ make_error_code() [1/6]

std::error_code join::make_error_code ( DigestErrc code )

create an std::error_code object.

Parameters

code	error code number.

Returns: the created std::error_code object.

◆ make_error_code() [2/6]

std::error_code join::make_error_code ( HttpErrc code )

create an std::error_code object.

Parameters

code	error code number.

Returns: the created std::error_code object.

◆ make_error_code() [3/6]

std::error_code join::make_error_code ( join::Errc code )

noexcept

Create an std::error_code object.

Parameters

code	Error code number.

Returns: The created std::error_code object.

◆ make_error_code() [4/6]

std::error_code join::make_error_code ( JsonErrc code )

noexcept

create an std::error_code object.

Parameters

code	error code number.

Returns: the created std::error_code object.

◆ make_error_code() [5/6]

std::error_code join::make_error_code ( SaxErrc code )

noexcept

create an std::error_code object.

Parameters

code	error code number.

Returns: the created std::error_code object.

◆ make_error_code() [6/6]

std::error_code join::make_error_code ( TlsErrc code )

create an std::error_code object.

Parameters

code	error code number.

Returns: the created std::error_code object.

◆ make_error_condition() [1/6]

std::error_condition join::make_error_condition ( DigestErrc code )

create an std::error_condition object.

Parameters

code	error code number.

Returns: the created std::error_condition object.

◆ make_error_condition() [2/6]

std::error_condition join::make_error_condition ( HttpErrc code )

create an std::error_condition object.

Parameters

code	error code number.

Returns: the created std::error_condition object.

◆ make_error_condition() [3/6]

std::error_condition join::make_error_condition ( join::Errc code )

noexcept

Create an std::error_condition object.

Parameters

code	Error code number.

Returns: The created std::error_condition object.

◆ make_error_condition() [4/6]

std::error_condition join::make_error_condition ( JsonErrc code )

noexcept

create an std::error_condition object.

Parameters

code	error code number.

Returns: the created std::error_condition object.

◆ make_error_condition() [5/6]

std::error_condition join::make_error_condition ( SaxErrc code )

noexcept

create an std::error_condition object.

Parameters

code	error code number.

Returns: the created std::error_condition object.

◆ make_error_condition() [6/6]

std::error_condition join::make_error_condition ( TlsErrc code )

create an std::error_condition object.

Parameters

code	error code number.

Returns: the created std::error_condition object.

◆ mime()

std::string join::mime ( const std::string & filepath )

inline

get mime type of the specified file.

Parameters

filepath path to parse.

Returns: mime type of the specified file.

◆ mlock()

int join::mlock	(	void *	ptr,
		size_t	size )

inlinenoexcept

lock memory in RAM.

Parameters

ptr	memory pointer.
size	memory size.

Returns: 0 on success, -1 on failure.

◆ mops()

std::ostream & join::mops ( std::ostream & out )

inline

set throughput display unit to Mops/sec.

Parameters

out	output stream.

Returns: reference to out.

◆ msec()

std::ostream & join::msec ( std::ostream & out )

inline

set latency display unit to milliseconds.

Parameters

out	output stream.

Returns: reference to out.

◆ nextPow2()

uint64_t join::nextPow2 ( uint64_t value )

constexprnoexcept

round up to the next power of two.

Parameters

value value to round up.

Returns: smallest power of two greater than or equal to value.

◆ nsec()

std::ostream & join::nsec ( std::ostream & out )

inline

set latency display unit to nanoseconds.

Parameters

out	output stream.

Returns: reference to out.

◆ operator&() [1/7]

IpAddress join::operator&	(	const IpAddress &	a,
		const IpAddress &	b )

perform AND operation on IP address.

Parameters

a	address to compare.
b	address to compare to.

Returns: result of AND operation on IpAddress.

◆ operator&() [2/7]

MacAddress join::operator&	(	const MacAddress &	a,
		const MacAddress &	b )

perform AND operation on MAC address.

Parameters

a	MAC address to compare.
b	MAC address to compare to.

Returns: result of AND operation on MacAddress.

◆ operator&() [3/7]

HttpMethod join::operator&	(	HttpMethod	__a,
		HttpMethod	__b )

inline

perform binary AND on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary AND on HttpMethod.

◆ operator&() [4/7]

InterfaceChangeType join::operator&	(	InterfaceChangeType	a,
		InterfaceChangeType	b )

inline

perform binary AND on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on InterfaceChangeType.

◆ operator&() [5/7]

JsonReadMode join::operator&	(	JsonReadMode	a,
		JsonReadMode	b )

constexprnoexcept

perform binary AND on JsonReadMode.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on JsonReadMode.

◆ operator&() [6/7]

NeighborChangeType join::operator&	(	NeighborChangeType	a,
		NeighborChangeType	b )

inline

perform binary AND on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on NeighborChangeType.

◆ operator&() [7/7]

RouteChangeType join::operator&	(	RouteChangeType	a,
		RouteChangeType	b )

inline

perform binary AND on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on RouteChangeType.

◆ operator&=() [1/5]

const HttpMethod & join::operator&=	(	HttpMethod &	__a,
		HttpMethod	__b )

inline

perform binary AND on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary AND on HttpMethod.

◆ operator&=() [2/5]

const InterfaceChangeType & join::operator&=	(	InterfaceChangeType &	a,
		InterfaceChangeType	b )

inline

perform binary AND assignment on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator&=() [3/5]

const JsonReadMode & join::operator&=	(	JsonReadMode &	a,
		JsonReadMode	b )

constexprnoexcept

perform binary AND on JsonReadMode.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on JsonReadMode.

◆ operator&=() [4/5]

const NeighborChangeType & join::operator&=	(	NeighborChangeType &	a,
		NeighborChangeType	b )

inline

perform binary AND on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary AND on NeighborChangeType.

◆ operator&=() [5/5]

const RouteChangeType & join::operator&=	(	RouteChangeType &	a,
		RouteChangeType	b )

inline

perform binary AND assignment on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator+() [1/2]

MacAddress join::operator+	(	const MacAddress &	a,
		int	value )

add the provided value to the provided MAC address.

Parameters

a	MAC address.
value	value to add to MAC address.

Returns: result of the addition operation on MacAddress.

◆ operator+() [2/2]

MacAddress join::operator+	(	int	value,
		const MacAddress &	a )

add the provided value to the provided MAC address.

Parameters

value	value to add to MAC address.
a	MAC address.

Returns: result of the addition operation on MacAddress.

◆ operator<<() [1/11]

template<class Protocol >

BasicHttpClient< Protocol > & join::operator<<	(	BasicHttpClient< Protocol > &	out,
		HttpRequest &	request )

constexpr

write HTTP request to the HTTP stream.

Parameters

out	HTTP output stream.
request	HTTP request.

Returns: a reference to the HTTP output stream.

◆ operator<<() [2/11]

template<class Protocol >

BasicHttpSecureClient< Protocol > & join::operator<<	(	BasicHttpSecureClient< Protocol > &	out,
		HttpRequest &	request )

constexpr

write request to the HTTPS stream.

Parameters

out	HTTP output stream.
request	request.

Returns: a reference to the HTTPS output stream.

◆ operator<<() [3/11]

template<class Protocol >

std::ostream & join::operator<<	(	std::ostream &	os,
		const BasicInternetEndpoint< Protocol > &	endpoint )

push endpoint representation into a stream.

Parameters

os	output stream.
endpoint	endpoint to push.

Returns: output stream.

◆ operator<<() [4/11]

template<class Protocol >

std::ostream & join::operator<<	(	std::ostream &	os,
		const BasicLinkLayerEndpoint< Protocol > &	endpoint )

push endpoint representation into a stream.

Parameters

os	output stream.
endpoint	endpoint to push.

Returns: output stream.

◆ operator<<() [5/11]

template<class Protocol >

std::ostream & join::operator<<	(	std::ostream &	os,
		const BasicNetlinkEndpoint< Protocol > &	endpoint )

push endpoint representation into a stream.

Parameters

os	output stream.
endpoint	endpoint to push.

Returns: output stream.

◆ operator<<() [6/11]

template<class Protocol >

std::ostream & join::operator<<	(	std::ostream &	os,
		const BasicUnixEndpoint< Protocol > &	endpoint )

push endpoint representation into a stream.

Parameters

os	output stream.
endpoint	endpoint to push.

Returns: output stream.

◆ operator<<() [7/11]

template<class ClockPolicy >

std::ostream & join::operator<<	(	std::ostream &	out,
		const BasicStats< ClockPolicy > &	statistics )

inline

stream insertion operator for statistics.

Parameters

out	destination stream.
statistics	statistics to print.

Returns: reference to out.

◆ operator<<() [8/11]

std::ostream & join::operator<<	(	std::ostream &	out,
		const DhcpOption &	options )

inline

insert options into stream.

Parameters

out	output stream.
options	options to insert.

Returns: a reference to the output stream.

◆ operator<<() [9/11]

std::ostream & join::operator<<	(	std::ostream &	out,
		const IpAddress &	address )

insert address into stream.

Parameters

out	output stream.
address	IP address.

Returns: a reference to the output stream.

◆ operator<<() [10/11]

std::ostream & join::operator<<	(	std::ostream &	out,
		const MacAddress &	a )

insert MAC address into stream.

Parameters

out	output stream.
a	MAC address.

Returns: a reference to the output stream.

◆ operator<<() [11/11]

std::ostream & join::operator<<	(	std::ostream &	out,
		const SmtpSender &	sender )

insert mail sender into stream.

Parameters

out	output stream.
sender	mail sender.

Returns: a reference to the output stream.

◆ operator<=>() [1/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicInternetEndpoint< Protocol > &	a,
		const BasicInternetEndpoint< Protocol > &	b )

noexcept

three-way compare endpoints.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [2/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicLinkLayerEndpoint< Protocol > &	a,
		const BasicLinkLayerEndpoint< Protocol > &	b )

noexcept

three-way compare endpoints.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [3/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicNetlinkEndpoint< Protocol > &	a,
		const BasicNetlinkEndpoint< Protocol > &	b )

noexcept

three-way compare endpoints.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [4/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicSocket< Protocol > &	a,
		const BasicSocket< Protocol > &	b )

inlinenoexcept

three-way compare socket handles.

Parameters

a	socket handle to compare.
b	socket handle to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [5/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicTls< Protocol > &	a,
		const BasicTls< Protocol > &	b )

inlinenoexcept

three-way compare TLS decorators.

Parameters

a	first TLS decorator.
b	second TLS decorator.

Returns: ordering of a relative to b.

◆ operator<=>() [6/18]

template<class Protocol >

std::strong_ordering join::operator<=>	(	const BasicUnixEndpoint< Protocol > &	a,
		const BasicUnixEndpoint< Protocol > &	b )

noexcept

three-way compare endpoints.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [7/18]

std::weak_ordering join::operator<=>	(	const DhcpOption &	lhs,
		const DhcpOption &	rhs )

inline

three-way compare options.

friendship with three-way comparison operator.

Parameters

lhs	options to compare.
rhs	options to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [8/18]

std::strong_ordering join::operator<=>	(	const Interface::Ptr &	lhs,
		const Interface::Ptr &	rhs )

inlinenoexcept

three-way compare interfaces.

Parameters

lhs	interface to compare.
rhs	interface to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [9/18]

std::strong_ordering join::operator<=>	(	const IpAddress &	a,
		const IpAddress &	b )

three-way compare IP addresses.

Parameters

a	address to compare.
b	address to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [10/18]

std::strong_ordering join::operator<=>	(	const MacAddress &	a,
		const MacAddress &	b )

three-way compare MAC addresses.

Parameters

a	address to compare.
b	address to compare to.

Returns: ordering of a relative to b.

◆ operator<=>() [11/18]

std::strong_ordering join::operator<=>	(	const Neighbor::Ptr &	lhs,
		const Neighbor::Ptr &	rhs )

inlinenoexcept

three-way compare neighbors.

Parameters

lhs	left side neighbor.
rhs	right side neighbor.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [12/18]

std::strong_ordering join::operator<=>	(	const NeighborKey &	lhs,
		const NeighborKey &	rhs )

inlinenoexcept

three-way compare neighbor keys.

Parameters

lhs	left side key.
rhs	right side key.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [13/18]

std::strong_ordering join::operator<=>	(	const Route::Ptr &	lhs,
		const Route::Ptr &	rhs )

inlinenoexcept

three-way compare routes.

Parameters

lhs	left side route.
rhs	right side route.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [14/18]

std::strong_ordering join::operator<=>	(	const RouteKey &	lhs,
		const RouteKey &	rhs )

inlinenoexcept

three-way compare route keys.

Parameters

lhs	left side key.
rhs	right side key.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [15/18]

std::partial_ordering join::operator<=>	(	const Value &	lhs,
		const Value &	rhs )

constexpr

three-way compare values.

Parameters

lhs	value to compare.
rhs	value to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [16/18]

template<typename... Ts>

details::VariantOrdering< Ts... > join::operator<=>	(	const Variant< Ts... > &	lhs,
		const Variant< Ts... > &	rhs )

constexpr

three-way compare variants.

Parameters

lhs	value to compare.
rhs	value to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [17/18]

template<typename Type >

std::partial_ordering join::operator<=>	(	const View< Type > &	lhs,
		const View< Type > &	rhs )

constexpr

three-way compare views.

Parameters

lhs	view to compare.
rhs	view to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator<=>() [18/18]

template<typename Type >
requires std::same_as<std::remove_const_t<Type>, char>

std::partial_ordering join::operator<=>	(	const View< Type > &	lhs,
		const View< Type > &	rhs )

constexpr

three-way compare character views.

Parameters

lhs	view to compare.
rhs	view to compare to.

Returns: ordering of lhs relative to rhs.

◆ operator==() [1/33]

template<class Protocol >

bool join::operator==	(	const BasicInternetEndpoint< Protocol > &	a,
		const BasicInternetEndpoint< Protocol > &	b )

noexcept

compare if equal.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: true if endpoints is equal, false otherwise.

◆ operator==() [2/33]

template<class Protocol >

bool join::operator==	(	const BasicLinkLayerEndpoint< Protocol > &	a,
		const BasicLinkLayerEndpoint< Protocol > &	b )

noexcept

compare if endpoints are equal.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: true if endpoints are equal, false otherwise.

◆ operator==() [3/33]

template<class Protocol >

bool join::operator==	(	const BasicNetlinkEndpoint< Protocol > &	a,
		const BasicNetlinkEndpoint< Protocol > &	b )

noexcept

compare if endpoints are equal.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: true if endpoints are equal, false otherwise.

◆ operator==() [4/33]

template<class Protocol >

bool join::operator==	(	const BasicSocket< Protocol > &	a,
		const BasicSocket< Protocol > &	b )

inlinenoexcept

compare if socket handles are equal.

Parameters

a	socket handle to compare.
b	socket handle to compare to.

Returns: true if equal.

◆ operator==() [5/33]

template<class Protocol >

bool join::operator==	(	const BasicTls< Protocol > &	a,
		const BasicTls< Protocol > &	b )

inlinenoexcept

compare if TLS decorators are equal.

Parameters

a	first TLS decorator.
b	second TLS decorator.

Returns: true if equal.

◆ operator==() [6/33]

template<class Protocol >

bool join::operator==	(	const BasicUnixEndpoint< Protocol > &	a,
		const BasicUnixEndpoint< Protocol > &	b )

noexcept

compare if endpoints are equal.

Parameters

a	endpoint to compare.
b	endpoint to compare to.

Returns: true if endpoints are equal, false otherwise.

◆ operator==() [7/33]

bool join::operator==	(	const Dhcp &	a,
		const Dhcp &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [8/33]

bool join::operator==	(	const DhcpOption &	lhs,
		const DhcpOption &	rhs )

inline

compare if equal.

friendship with equal operator.

Parameters

lhs	options to compare.
rhs	options to compare to.

Returns: true if equal.

◆ operator==() [9/33]

bool join::operator==	(	const Dns &	a,
		const Dns &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [10/33]

bool join::operator==	(	const Dot &	a,
		const Dot &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [11/33]

bool join::operator==	(	const Dtls &	a,
		const Dtls &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [12/33]

bool join::operator==	(	const Http &	a,
		const Http &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [13/33]

bool join::operator==	(	const Https &	a,
		const Https &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [14/33]

bool join::operator==	(	const Icmp &	a,
		const Icmp &	b )

constexprnoexcept

check if equal.

Parameters

a	protocol to compare.
b	protocol to compare to.

Returns: true if equal.

◆ operator==() [15/33]

bool join::operator==	(	const Interface::Ptr &	lhs,
		const Interface::Ptr &	rhs )

inlinenoexcept

compare if two interfaces are equal.

Parameters

lhs	interface to compare.
rhs	interface to compare to.

Returns: true if equal.

◆ operator==() [16/33]

bool join::operator==	(	const IpAddress &	a,
		const IpAddress &	b )

compare if two IP address are equals.

Parameters

a	address to compare.
b	address to compare to.

Returns: true if equal.

◆ operator==() [17/33]

bool join::operator==	(	const MacAddress &	a,
		const MacAddress &	b )

compare if two MAC address are equals.

Parameters

a	MAC address to compare.
b	MAC address to compare to.

Returns: true if equal.

◆ operator==() [18/33]

bool join::operator==	(	const Mdns &	a,
		const Mdns &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [19/33]

bool join::operator==	(	const Ndp &	a,
		const Ndp &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [20/33]

bool join::operator==	(	const Neighbor::Ptr &	lhs,
		const Neighbor::Ptr &	rhs )

inlinenoexcept

compare if two neighbor are equal.

Parameters

lhs	left side key.
rhs	right side key.

Returns: true if both are equal.

◆ operator==() [21/33]

bool join::operator==	(	const NeighborKey &	lhs,
		const NeighborKey &	rhs )

inlinenoexcept

compare if two neighbor keys are equal.

Parameters

lhs	left side key.
rhs	right side key.

Returns: true if both keys are equal.

◆ operator==() [22/33]

bool join::operator==	(	const Netlink &	a,
		const Netlink &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [23/33]

bool join::operator==	(	const Route::Ptr &	lhs,
		const Route::Ptr &	rhs )

inlinenoexcept

compare if two routes are equal.

Parameters

lhs	left side route.
rhs	right side route.

Returns: true if both are equal.

◆ operator==() [24/33]

bool join::operator==	(	const RouteKey &	lhs,
		const RouteKey &	rhs )

inlinenoexcept

compare if two route keys are equal.

Parameters

lhs	left side key.
rhs	right side key.

Returns: true if both keys are equal.

◆ operator==() [25/33]

bool join::operator==	(	const Smtp &	a,
		const Smtp &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [26/33]

bool join::operator==	(	const Smtps &	a,
		const Smtps &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [27/33]

bool join::operator==	(	const Tcp &	a,
		const Tcp &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [28/33]

bool join::operator==	(	const Tls &	a,
		const Tls &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [29/33]

bool join::operator==	(	const Udp &	a,
		const Udp &	b )

constexprnoexcept

check if equals.

Parameters

a	protocol to check.
b	protocol to check.

Returns: true if equals.

◆ operator==() [30/33]

bool join::operator==	(	const Value &	lhs,
		const Value &	rhs )

constexpr

compare if equal.

Parameters

lhs	value to compare.
rhs	value to compare to.

Returns: true if equal.

◆ operator==() [31/33]

template<typename... Ts>

bool join::operator==	(	const Variant< Ts... > &	lhs,
		const Variant< Ts... > &	rhs )

constexpr

compare if equal.

Parameters

lhs	value to compare.
rhs	value to compare to.

Returns: true if equal.

◆ operator==() [32/33]

template<typename Type >

bool join::operator==	(	const View< Type > &	lhs,
		const View< Type > &	rhs )

constexpr

compare views.

Parameters

lhs	view to compare.
rhs	view to compare to.

Returns: true if equal.

◆ operator==() [33/33]

template<typename Type >
requires std::same_as<std::remove_const_t<Type>, char>

bool join::operator==	(	const View< Type > &	lhs,
		const View< Type > &	rhs )

constexpr

compare character views.

Parameters

lhs	view to compare.
rhs	view to compare to.

Returns: true if equal.

◆ operator>>() [1/2]

template<class Protocol >

BasicHttpClient< Protocol > & join::operator>>	(	BasicHttpClient< Protocol > &	in,
		HttpResponse &	response )

constexpr

read HTTP response from the HTTP stream.

Parameters

in	HTTP input stream.
response	HTTP response.

Returns: a reference to the HTTP input stream.

◆ operator>>() [2/2]

template<class Protocol >

BasicHttpSecureClient< Protocol > & join::operator>>	(	BasicHttpSecureClient< Protocol > &	in,
		HttpResponse &	response )

constexpr

read response from the HTTPS stream.

Parameters

in	HTTPS input stream.
response	response.

Returns: a reference to the HTTPS input stream.

◆ operator^() [1/6]

IpAddress join::operator^	(	const IpAddress &	a,
		const IpAddress &	b )

perform XOR operation on IP address.

Parameters

a	address to compare.
b	address to compare to.

Returns: result of XOR operation on IpAddress.

◆ operator^() [2/6]

MacAddress join::operator^	(	const MacAddress &	a,
		const MacAddress &	b )

perform XOR operation on MAC address.

Parameters

a	MAC address to compare.
b	MAC address to compare to.

Returns: result of XOR operation on MacAddress.

◆ operator^() [3/6]

HttpMethod join::operator^	(	HttpMethod	__a,
		HttpMethod	__b )

inline

perform binary XOR on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary XOR on HttpMethod.

◆ operator^() [4/6]

InterfaceChangeType join::operator^	(	InterfaceChangeType	a,
		InterfaceChangeType	b )

inline

perform binary XOR on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary XOR on InterfaceChangeType.

◆ operator^() [5/6]

NeighborChangeType join::operator^	(	NeighborChangeType	a,
		NeighborChangeType	b )

inline

perform binary XOR on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary XOR on NeighborChangeType.

◆ operator^() [6/6]

RouteChangeType join::operator^	(	RouteChangeType	a,
		RouteChangeType	b )

inline

perform binary XOR on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary XOR on RouteChangeType.

◆ operator^=() [1/4]

const HttpMethod & join::operator^=	(	HttpMethod &	__a,
		HttpMethod	__b )

inline

perform binary XOR on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary XOR on HttpMethod.

◆ operator^=() [2/4]

const InterfaceChangeType & join::operator^=	(	InterfaceChangeType &	a,
		InterfaceChangeType	b )

inline

perform binary XOR assignment on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator^=() [3/4]

const NeighborChangeType & join::operator^=	(	NeighborChangeType &	a,
		NeighborChangeType	b )

inline

perform binary XOR on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary XOR on NeighborChangeType.

◆ operator^=() [4/4]

const RouteChangeType & join::operator^=	(	RouteChangeType &	a,
		RouteChangeType	b )

inline

perform binary XOR assignment on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator|() [1/7]

IpAddress join::operator\|	(	const IpAddress &	a,
		const IpAddress &	b )

perform OR operation on IP address.

Parameters

a	address to compare.
b	address to compare to.

Returns: result of OR operation on IpAddress.

◆ operator|() [2/7]

MacAddress join::operator\|	(	const MacAddress &	a,
		const MacAddress &	b )

perform OR operation on MAC address.

Parameters

a	MAC address to compare.
b	MAC address to compare to.

Returns: result of OR operation on MacAddress.

◆ operator|() [3/7]

HttpMethod join::operator\|	(	HttpMethod	__a,
		HttpMethod	__b )

inline

perform binary OR on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary OR on HttpMethod.

◆ operator|() [4/7]

InterfaceChangeType join::operator\|	(	InterfaceChangeType	a,
		InterfaceChangeType	b )

inline

perform binary OR on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR on InterfaceChangeType.

◆ operator|() [5/7]

JsonReadMode join::operator\|	(	JsonReadMode	a,
		JsonReadMode	b )

constexprnoexcept

perform binary OR on JsonReadMode.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR on JsonReadMode.

◆ operator|() [6/7]

NeighborChangeType join::operator\|	(	NeighborChangeType	a,
		NeighborChangeType	b )

inline

perform binary OR on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR on NeighborChangeType.

◆ operator|() [7/7]

RouteChangeType join::operator\|	(	RouteChangeType	a,
		RouteChangeType	b )

inline

perform binary OR on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR on RouteChangeType.

◆ operator|=() [1/5]

const HttpMethod & join::operator\|=	(	HttpMethod &	__a,
		HttpMethod	__b )

inline

perform binary OR on HttpMethod.

Parameters

__a	bitset.
__b	other bitset.

Returns: bitset result of binary OR.

◆ operator|=() [2/5]

const InterfaceChangeType & join::operator\|=	(	InterfaceChangeType &	a,
		InterfaceChangeType	b )

inline

perform binary OR assignment on InterfaceChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator|=() [3/5]

const JsonReadMode & join::operator\|=	(	JsonReadMode &	a,
		JsonReadMode	b )

constexprnoexcept

perform binary OR on JsonReadMode.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR.

◆ operator|=() [4/5]

const NeighborChangeType & join::operator\|=	(	NeighborChangeType &	a,
		NeighborChangeType	b )

inline

perform binary OR on NeighborChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: bitset result of binary OR.

◆ operator|=() [5/5]

const RouteChangeType & join::operator\|=	(	RouteChangeType &	a,
		RouteChangeType	b )

inline

perform binary OR assignment on RouteChangeType.

Parameters

a	bitset.
b	other bitset.

Returns: reference to updated bitset.

◆ operator~() [1/4]

HttpMethod join::operator~ ( HttpMethod __a )

inline

perform binary NOT on HttpMethod.

Parameters

__a bitset.

Returns: bitset result of binary NOT on HttpMethod.

◆ operator~() [2/4]

InterfaceChangeType join::operator~ ( InterfaceChangeType a )

inline

perform binary NOT on InterfaceChangeType.

Parameters

a bitset.

Returns: bitset result of binary NOT on InterfaceChangeType.

◆ operator~() [3/4]

NeighborChangeType join::operator~ ( NeighborChangeType a )

inline

perform binary NOT on NeighborChangeType.

Parameters

a bitset.

Returns: bitset result of binary NOT on NeighborChangeType.

◆ operator~() [4/4]

RouteChangeType join::operator~ ( RouteChangeType a )

inline

perform binary NOT on RouteChangeType.

Parameters

a bitset.

Returns: bitset result of binary NOT on RouteChangeType.

◆ ops()

std::ostream & join::ops ( std::ostream & out )

inline

set throughput display unit to ops/sec.

Parameters

out	output stream.

Returns: reference to out.

◆ pageSize()

uint64_t join::pageSize ( )

inlinenoexcept

get the system page size.

Returns: the page size in bytes.

◆ parallelForEach()

template<class InputIt , class Func >

void join::parallelForEach	(	InputIt	first,
		InputIt	last,
		Func	function )

parallel for each loop.

Parameters

first	first iterator.
last	last iterator.
function	function to execute in parallel.

◆ randomize()

template<typename Type >

Type join::randomize ( )

create a random number.

Returns: random number.

◆ readBytes()

bool join::readBytes	(	const char *&	cur,
		const char *	end,
		void *	out,
		size_t	size )

inlinenoexcept

read bytes from a buffer.

Parameters

cur	current position, advanced on success.
end	end of the buffer.
out	where to copy the bytes.
size	number of bytes to read.

Returns: true on success, false if not enough bytes remain.

◆ replaceAll()

std::string & join::replaceAll	(	std::string &	str,
		const std::string &	toReplace,
		const std::string &	by )

inline

replace all occurrences of a substring.

Parameters

str	string to scan.
toReplace	string to replace.
by	string to put instead of the "toReplace" substring.

Returns: a reference to the string.

◆ rsplit()

std::vector< std::string > join::rsplit	(	const std::string &	in,
		const std::string &	delim )

inline

split a string in reverse order using a delimiter.

Parameters

in	string to split.
delim	delimiter.

Returns: list of tokens.

◆ saxCategory()

const std::error_category & join::saxCategory ( )

noexcept

get error category.

Returns: the created std::error_category object.

◆ sec()

std::ostream & join::sec ( std::ostream & out )

inline

set latency display unit to seconds.

Parameters

out	output stream.

Returns: reference to out.

◆ split()

std::vector< std::string > join::split	(	const std::string &	in,
		const std::string &	delim )

inline

split a string using a delimiter.

Parameters

in	string to split.
delim	delimiter.

Returns: list of tokens.

◆ statsHeader()

std::ostream & join::statsHeader ( std::ostream & out )

inline

print the statistics table header to a stream.

Parameters

out	output stream.

Returns: reference to out.

◆ swap() [1/2]

template<class Type >
requires (std::is_arithmetic_v<Type> && sizeof (Type) <= sizeof (uint64_t))

Type & join::swap ( Type & val )

inline

swaps byte orders.

Parameters

val	value to swap.

Returns: the swapped value.

◆ swap() [2/2]

template<typename... Ts>

void join::swap	(	Variant< Ts... > &	lhs,
		Variant< Ts... > &	rhs )

noexcept

swap two variants.

Parameters

lhs	first variant.
rhs	second variant.

◆ toTimespec() [1/2]

template<typename Rep , typename Period >

struct timespec join::toTimespec ( std::chrono::duration< Rep, Period > duration )

converts duration to timespec.

Parameters

duration the duration to convert.

Returns: timespec structure.

◆ toTimespec() [2/2]

template<typename Clock , typename Duration >

struct timespec join::toTimespec ( std::chrono::time_point< Clock, Duration > timePoint )

converts time_point to timespec.

Parameters

timePoint the time point to convert.

Returns: timespec structure.

◆ trim()

std::string & join::trim ( std::string & s )

inline

trim.

Parameters

s	string to trim.

Returns: trimed string.

◆ trimLeft()

std::string & join::trimLeft ( std::string & s )

inline

trim left.

Parameters

s	string to trim.

Returns: trimed string.

◆ trimRight()

std::string & join::trimRight ( std::string & s )

inline

trim right.

Parameters

s	string to trim.

Returns: trimed string.

◆ usec()

std::ostream & join::usec ( std::ostream & out )

inline

set latency display unit to microseconds.

Parameters

out	output stream.

Returns: reference to out.

◆ writeBytes()

bool join::writeBytes	(	char *&	cur,
		const char *	end,
		const void *	in,
		size_t	size )

inlinenoexcept

write bytes to a buffer.

Parameters

cur	current position, advanced on success.
end	end of the buffer.
in	bytes to write.
size	number of bytes to write.

Returns: true on success, false if not enough room remains.

Variable Documentation

◆ count_v

template<typename T , typename... Ts>

std::size_t join::count_v = (std::size_t{0} + ... + std::is_same_v<T, Ts>)

inlineconstexpr

count the number of time a type appears in a parameter pack.

◆ defaultCipher

const std::string join::defaultCipher

extern

Initial value:

=
    "EECDH+ECDSA+AESGCM:EECDH+aRSA+AESGCM:EECDH+ECDSA+CHACHA20:EECDH+aRSA+CHACHA20:EECDH+ECDSA+AESCCM:"
    "EDH+DSS+AESGCM:EDH+aRSA+CHACHA20:EDH+aRSA+AESCCM:-AESCCM8:EECDH+ECDSA+AESCCM8:EDH+aRSA+AESCCM8"

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

◆ defaultCipher_1_3

const std::string join::defaultCipher_1_3

extern

Initial value:

=
    "TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256:TLS_CHACHA20_POLY1305_SHA256:"
    "TLS_AES_128_CCM_SHA256:TLS_AES_128_CCM_8_SHA256"

◆ find_index_v

template<typename T , typename... Ts>

std::size_t join::find_index_v = 0

inlineconstexpr

get element position in a parameter pack according its type.

◆ find_index_v< T, First, Ts... >

template<typename T , typename First , typename... Ts>

std::size_t join::find_index_v< T, First, Ts... >

inlineconstexpr

Initial value:

=

std::is_same_v<T, First> ? 0 : find_index_v<T, Ts...> + 1

join::find_index_v

constexpr std::size_t find_index_v

template<typename T , typename... Ts>

bool join::is_unique_v = count_v<T, Ts...> == 1

inlineconstexpr

check if a type only appears one time in a parameter pack.

◆ lastError

thread_local std::error_code join::lastError

extern

last error.

◆ needs_seq_v

template<typename SyncPolicy >

bool join::needs_seq_v = true

inlineconstexpr

primary trait: all sync policies need sequence numbers by default.

◆ needs_seq_v< Spsc< Type, Backend > >

template<typename Type , typename Backend >

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ AliasList

◆ Array

◆ AsyncOp

◆ BigNumPtr

◆ ByteList

◆ BytesArray

◆ DhcpOptionValue

◆ DhKeyPtr

◆ EcdhKeyPtr

◆ EcdsaSigPtr

◆ EvpEncodeCtxPtr

◆ EvpMdCtxPtr

◆ EvpPkeyCtxPtr

◆ EvpPkeyPtr

◆ ExchangerList

◆ Futex

◆ HmacCtxPtr

◆ InterfaceList

◆ IpAddressList

◆ IpList

◆ JsonCanonicalizer

◆ JsonReader

◆ JsonWriter

◆ match_t

◆ Member

◆ NeighborList

◆ Object

◆ PiFutex

◆ Proactor

◆ ProactorThread

◆ RouteList

◆ ServerList

◆ SharedFutex

◆ SharedPiFutex

◆ SmtpRecipients

◆ SslCtxPtr

◆ SslPtr

◆ StackOfGeneralNamePtr

◆ StackOfX509NamePtr

◆ WordList

Enumeration Type Documentation

◆ DigestErrc

◆ Errc

◆ HttpContentType

◆ HttpErrc

◆ HttpMethod

◆ InterfaceChangeType

◆ JsonErrc

◆ JsonReadMode

◆ JsonWriteMode

◆ NeighborChangeType

◆ RouteChangeType

◆ SaxErrc

◆ TlsErrc

Function Documentation

◆ __attribute__() [1/2]

◆ __attribute__() [2/2]

◆ base()

◆ benchmark()

◆ bin2hex()

◆ checksum()

◆ compareNoCase()

◆ distribute()

◆ dump()

◆ exists()

◆ extension()

◆ filename()

◆ getDigestCategory()

◆ getErrorCategory()

◆ getline() [1/2]

◆ getline() [2/2]

◆ getTlsCategory()

◆ attribute() [1/2]

◆ attribute() [2/2]