byte_order.hxx File Reference

#include <endian.h>
#include <byteswap.h>
#include <arpa/inet.h>
#include <cosmos/types.hxx>
#include <cosmos/utils.hxx>

Go to the source code of this file.

Classes
struct	cosmos::net::EndianTraits< endian >
struct	cosmos::net::EndianTraits< Endian::LITTLE >
struct	cosmos::net::EndianTraits< Endian::BIG >
struct	cosmos::net::RawIntTraits< UINT, endian >
struct	cosmos::net::RawIntTraits< uint16_t, Endian::LITTLE >
struct	cosmos::net::RawIntTraits< uint32_t, Endian::LITTLE >
struct	cosmos::net::RawIntTraits< uint64_t, Endian::LITTLE >
struct	cosmos::net::RawIntTraits< uint16_t, Endian::BIG >
struct	cosmos::net::RawIntTraits< uint32_t, Endian::BIG >
struct	cosmos::net::RawIntTraits< uint64_t, Endian::BIG >
class	cosmos::net::EndianNumber< T, endianness >
	An endianness aware unsigned integer. More...

Typedefs
using	cosmos::net::RawNetInt16 = RawBigInt16
using	cosmos::net::RawNetInt32 = RawBigInt32
using	cosmos::net::RawNetInt64 = RawBigInt64
using	cosmos::net::LittleInt16 = EndianNumber<uint16_t, Endian::LITTLE>
using	cosmos::net::LittleInt32 = EndianNumber<uint32_t, Endian::LITTLE>
using	cosmos::net::LittleInt64 = EndianNumber<uint64_t, Endian::LITTLE>
using	cosmos::net::BigInt16 = EndianNumber<uint16_t, Endian::BIG>
using	cosmos::net::BigInt32 = EndianNumber<uint32_t, Endian::BIG>
using	cosmos::net::BigInt64 = EndianNumber<uint64_t, Endian::BIG>
using	cosmos::net::NetInt16 = BigInt16
using	cosmos::net::NetInt32 = BigInt32
using	cosmos::net::NetInt64 = BigInt64
using	cosmos::net::HostInt16 = EndianNumber<uint16_t, our_endian>
using	cosmos::net::HostInt32 = EndianNumber<uint32_t, our_endian>
using	cosmos::net::HostInt64 = EndianNumber<uint64_t, our_endian>

Enumerations
enum class	cosmos::net::Endian { LITTLE , BIG }
	Differentiation between different endianness storage format. More...
enum class	RawLittleInt16 : uint16_t
enum class	RawLittleInt32 : uint32_t
enum class	RawLittleInt64 : uint64_t
enum class	RawBigInt16 : uint16_t
enum class	RawBigInt32 : uint32_t
enum class	RawBigInt64 : uint64_t

Functions
uint16_t	cosmos::net::swap_byte_order (uint16_t value)
	Return the reversed byte order for the given 16 bit value.
uint32_t	cosmos::net::swap_byte_order (uint32_t value)
	Return the reversed byte order for the given 32 bit value.
uint64_t	cosmos::net::swap_byte_order (uint64_t value)
	Return the reversed byte order for the given 64 bit value.
template<typename T >
T	cosmos::net::to_network_order (T host)
	Return the network byte order version of host.
template<typename T >
T	cosmos::net::to_host_order (T network)
	Return the host byte order version of network.

Variables
constexpr auto	cosmos::net::our_endian = Endian::LITTLE
	The byte order setting for the current host.
constexpr auto	cosmos::net::foreign_endian = (our_endian == Endian::LITTLE ? Endian::BIG : Endian::LITTLE)

Detailed Description

Helper types and functions for dealing with byte order (endianness) of unsigned integers of different sizes.

Definition in file byte_order.hxx.

Typedef Documentation

BigInt16

using cosmos::net::BigInt16 = EndianNumber<uint16_t, Endian::BIG>

Definition at line 226 of file byte_order.hxx.

BigInt32

using cosmos::net::BigInt32 = EndianNumber<uint32_t, Endian::BIG>

Definition at line 227 of file byte_order.hxx.

BigInt64

using cosmos::net::BigInt64 = EndianNumber<uint64_t, Endian::BIG>

Definition at line 228 of file byte_order.hxx.

HostInt16

using cosmos::net::HostInt16 = EndianNumber<uint16_t, our_endian>

Definition at line 234 of file byte_order.hxx.

HostInt32

using cosmos::net::HostInt32 = EndianNumber<uint32_t, our_endian>

Definition at line 235 of file byte_order.hxx.

HostInt64

using cosmos::net::HostInt64 = EndianNumber<uint64_t, our_endian>

Definition at line 236 of file byte_order.hxx.

LittleInt16

using cosmos::net::LittleInt16 = EndianNumber<uint16_t, Endian::LITTLE>

Definition at line 222 of file byte_order.hxx.

LittleInt32

using cosmos::net::LittleInt32 = EndianNumber<uint32_t, Endian::LITTLE>

Definition at line 223 of file byte_order.hxx.

LittleInt64

using cosmos::net::LittleInt64 = EndianNumber<uint64_t, Endian::LITTLE>

Definition at line 224 of file byte_order.hxx.

NetInt16

using cosmos::net::NetInt16 = BigInt16

Definition at line 230 of file byte_order.hxx.

NetInt32

using cosmos::net::NetInt32 = BigInt32

Definition at line 231 of file byte_order.hxx.

NetInt64

using cosmos::net::NetInt64 = BigInt64

Definition at line 232 of file byte_order.hxx.

RawNetInt16

using cosmos::net::RawNetInt16 = RawBigInt16

Definition at line 117 of file byte_order.hxx.

RawNetInt32

using cosmos::net::RawNetInt32 = RawBigInt32

Definition at line 118 of file byte_order.hxx.

RawNetInt64

using cosmos::net::RawNetInt64 = RawBigInt64

Definition at line 119 of file byte_order.hxx.

Enumeration Type Documentation

Endian

enum class cosmos::net::Endian

strong

Differentiation between different endianness storage format.

Enumerator
LITTLE	Little endian. Lower value bits are stored first.
BIG	Big endian. Higher value bits are stored first.

Definition at line 24 of file byte_order.hxx.

                  {
        LITTLE,
        BIG
};

RawBigInt16

enum class cosmos::net::RawBigInt16 : uint16_t

strong

Definition at line 114 of file byte_order.hxx.

: uint16_t {};

RawBigInt32

enum class cosmos::net::RawBigInt32 : uint32_t

strong

Definition at line 115 of file byte_order.hxx.

: uint32_t {};

RawBigInt64

enum class cosmos::net::RawBigInt64 : uint64_t

strong

Definition at line 116 of file byte_order.hxx.

: uint64_t {};

RawLittleInt16

enum class cosmos::net::RawLittleInt16 : uint16_t

strong

Definition at line 111 of file byte_order.hxx.

: uint16_t {};

RawLittleInt32

enum class cosmos::net::RawLittleInt32 : uint32_t

strong

Definition at line 112 of file byte_order.hxx.

: uint32_t {};

RawLittleInt64

enum class cosmos::net::RawLittleInt64 : uint64_t

strong

Definition at line 113 of file byte_order.hxx.

: uint64_t {};

Function Documentation

swap_byte_order() [1/3]

uint16_t cosmos::net::swap_byte_order ( uint16_t value )

inline

Return the reversed byte order for the given 16 bit value.

Definition at line 71 of file byte_order.hxx.

                                                {
        return bswap_16(value);
}

swap_byte_order() [2/3]

uint32_t cosmos::net::swap_byte_order ( uint32_t value )

inline

Return the reversed byte order for the given 32 bit value.

Definition at line 76 of file byte_order.hxx.

                                                {
        return bswap_32(value);
}

swap_byte_order() [3/3]

uint64_t cosmos::net::swap_byte_order ( uint64_t value )

inline

Return the reversed byte order for the given 64 bit value.

Definition at line 81 of file byte_order.hxx.

                                                {
        return bswap_64(value);
}

to_host_order()

template<typename T >

T cosmos::net::to_host_order ( T network )

inline

Return the host byte order version of network.

Definition at line 97 of file byte_order.hxx.

                                  {
        if (our_endian == Endian::BIG) {
                return network;
        } else {
                return swap_byte_order(network);
        }
}

to_network_order()

template<typename T >

T cosmos::net::to_network_order ( T host )

inline

Return the network byte order version of host.

Definition at line 87 of file byte_order.hxx.

                                  {
        if (our_endian == Endian::BIG) {
                return host;
        } else {
                return swap_byte_order(host);
        }
}

Variable Documentation

foreign_endian

auto cosmos::net::foreign_endian = (our_endian == Endian::LITTLE ? Endian::BIG : Endian::LITTLE)

constexpr

Definition at line 45 of file byte_order.hxx.

our_endian

auto cosmos::net::our_endian = Endian::LITTLE

constexpr

The byte order setting for the current host.

Definition at line 37 of file byte_order.hxx.