The root namespace for WFIO. More...

Namespaces
	beos
	Elements of WFIO related to BeOS.

Classes
class	BinStream
	Wrap a wfio_binstream_t. More...

struct	DCntl
	A command to be supplied to a device or similar stream. More...

class	Device
	A C++ wrapper for a wfio_device_t. More...

class	FDDevice
	A Device wrapping a file descriptor. More...

class	FileDevice
	A Device wrapping a file stream. More...

class	IOBuf
	A C++ wrapper for a wfio_iobuf_t. More...

struct	IOShare
	An IO sharing mode. More...

class	Peer

class	StdioDevice
	A Device wrapping a standard IO device. More...

Typedefs
typedef ::wfio_sint8_t	sint8_t

typedef ::wfio_uint8_t	uint8_t

typedef ::wfio_sint16_t	sint16_t

typedef ::wfio_uint16_t	uint16_t

typedef ::wfio_sint32_t	sint32_t

typedef ::wfio_uint32_t	uint32_t

typedef ::wfio_sint64_t	sint64_t

typedef ::wfio_uint64_t	uint64_t

typedef ::wfio_off_t	off_t
	An integer corresponding to a device offset. More...

typedef ::wfio_fd_t	fd_t
	The type corresponding a file descriptor. More...

typedef ::wfio_undefined_t	undefined_t
	A structure indicating no definition. More...

typedef ::wfio_endian_t	endian_t
	A categorization of the byte-order of multibyte integers. More...

Enumerations
enum	{ NPOS = ::WFIO_NPOS }

Functions
void	convertEndian (const wfio::sint16_t src, wfio::endian_t srcEndian, wfio::sint16_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 16-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::sint16_t src, wfio::sint16_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 16-bit signed integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::sint16_t src, wfio::sint16_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 16-bit signed integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::sint16_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 16-bit signed integers in `buf`. More...

void	fromHostEndian (wfio::sint16_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 16-bit signed integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::sint16_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 16-bit signed integers in `buf` from `srcEndian` to that of the host. More...

wfio_sint16_t	convertEndian (wfio::sint16_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 16-bit signed integer. More...

wfio_sint16_t	fromHostEndian (wfio::sint16_t x, wfio::endian_t destEndian) throw ()
	Convert a 16-bit signed integers from the host endianness to that of `dest`. More...

wfio_sint16_t	toHostEndian (wfio::sint16_t x, wfio::endian_t srcEndian) throw ()
	Convert a 16-bit signed integer from `src` to that of the host. More...

void	convertEndian (const wfio::uint16_t src, wfio::endian_t srcEndian, wfio::uint16_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 16-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::uint16_t src, wfio::uint16_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 16-bit unsigned integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::uint16_t src, wfio::uint16_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 16-bit unsigned integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::uint16_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 16-bit unsigned integers in `buf`. More...

void	fromHostEndian (wfio::uint16_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 16-bit unsigned integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::uint16_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 16-bit unsigned integers in `buf` from `srcEndian` to that of the host. More...

wfio_uint16_t	convertEndian (wfio::uint16_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 16-bit unsigned integer. More...

wfio_uint16_t	fromHostEndian (wfio::uint16_t x, wfio::endian_t destEndian) throw ()
	Convert a 16-bit unsigned integers from the host endianness to that of `dest`. More...

wfio_uint16_t	toHostEndian (wfio::uint16_t x, wfio::endian_t srcEndian) throw ()
	Convert a 16-bit unsigned integer from `src` to that of the host. More...

void	convertEndian (const wfio::sint32_t src, wfio::endian_t srcEndian, wfio::sint32_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 32-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::sint32_t src, wfio::sint32_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 32-bit signed integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::sint32_t src, wfio::sint32_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 32-bit signed integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::sint32_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 32-bit signed integers in `buf`. More...

void	fromHostEndian (wfio::sint32_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 32-bit signed integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::sint32_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 32-bit signed integers in `buf` from `srcEndian` to that of the host. More...

wfio_sint32_t	convertEndian (wfio::sint32_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 32-bit signed integer. More...

wfio_sint32_t	fromHostEndian (wfio::sint32_t x, wfio::endian_t destEndian) throw ()
	Convert a 32-bit signed integers from the host endianness to that of `dest`. More...

wfio_sint32_t	toHostEndian (wfio::sint32_t x, wfio::endian_t srcEndian) throw ()
	Convert a 32-bit signed integer from `src` to that of the host. More...

void	convertEndian (const wfio::uint32_t src, wfio::endian_t srcEndian, wfio::uint32_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 32-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::uint32_t src, wfio::uint32_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 32-bit unsigned integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::uint32_t src, wfio::uint32_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 32-bit unsigned integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::uint32_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 32-bit unsigned integers in `buf`. More...

void	fromHostEndian (wfio::uint32_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 32-bit unsigned integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::uint32_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 32-bit unsigned integers in `buf` from `srcEndian` to that of the host. More...

wfio_uint32_t	convertEndian (wfio::uint32_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 32-bit unsigned integer. More...

wfio_uint32_t	fromHostEndian (wfio::uint32_t x, wfio::endian_t destEndian) throw ()
	Convert a 32-bit unsigned integers from the host endianness to that of `dest`. More...

wfio_uint32_t	toHostEndian (wfio::uint32_t x, wfio::endian_t srcEndian) throw ()
	Convert a 32-bit unsigned integer from `src` to that of the host. More...

void	convertEndian (const wfio::sint64_t src, wfio::endian_t srcEndian, wfio::sint64_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 64-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::sint64_t src, wfio::sint64_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 64-bit signed integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::sint64_t src, wfio::sint64_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 64-bit signed integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::sint64_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 64-bit signed integers in `buf`. More...

void	fromHostEndian (wfio::sint64_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 64-bit signed integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::sint64_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 64-bit signed integers in `buf` from `srcEndian` to that of the host. More...

wfio_sint64_t	convertEndian (wfio::sint64_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 64-bit signed integer. More...

wfio_sint64_t	fromHostEndian (wfio::sint64_t x, wfio::endian_t destEndian) throw ()
	Convert a 64-bit signed integers from the host endianness to that of `dest`. More...

wfio_sint64_t	toHostEndian (wfio::sint64_t x, wfio::endian_t srcEndian) throw ()
	Convert a 64-bit signed integer from `src` to that of the host. More...

void	convertEndian (const wfio::uint64_t src, wfio::endian_t srcEndian, wfio::uint64_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Perform endianness conversion on 64-bit signed integers in `src` to be stored in `dest`. More...

void	fromHostEndian (const wfio::uint64_t src, wfio::uint64_t dest, wfio::endian_t destEndian, size_t len) throw ()
	Convert 64-bit unsigned integers in `src` from the host endianness to that of `destEndian` and store them in `dest`. More...

void	toHostEndian (const wfio::uint64_t src, wfio::uint64_t dest, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 64-bit unsigned integers in `src` from `srcEndian` to that of the host and store them in `dest`. More...

void	convertEndian (wfio::uint64_t *buf, wfio::endian_t src, wfio::endian_t dest, size_t len) throw ()
	Perform endianness conversion on 64-bit unsigned integers in `buf`. More...

void	fromHostEndian (wfio::uint64_t *buf, wfio::endian_t destEndian, size_t len) throw ()
	Convert 64-bit unsigned integers in `buf` from the host endianness to that of `destEndian`. More...

void	toHostEndian (wfio::uint64_t *buf, wfio::endian_t srcEndian, size_t len) throw ()
	Convert 64-bit unsigned integers in `buf` from `srcEndian` to that of the host. More...

wfio_uint64_t	convertEndian (wfio::uint64_t x, wfio::endian_t src, wfio::endian_t dest) throw ()
	Perform endianness conversion on a 64-bit unsigned integer. More...

wfio_uint64_t	fromHostEndian (wfio::uint64_t x, wfio::endian_t destEndian) throw ()
	Convert a 64-bit unsigned integers from the host endianness to that of `dest`. More...

wfio_uint64_t	toHostEndian (wfio::uint64_t x, wfio::endian_t srcEndian) throw ()
	Convert a 64-bit unsigned integer from `src` to that of the host. More...

Detailed Description

The root namespace for WFIO.

Typedef Documentation

◆ endian_t

typedef ::wfio_endian_t wfio::endian_t

A categorization of the byte-order of multibyte integers.

◆ fd_t

typedef ::wfio_fd_t wfio::fd_t

The type corresponding a file descriptor.

◆ off_t

typedef ::wfio_off_t wfio::off_t

An integer corresponding to a device offset.

◆ sint16_t

typedef ::wfio_sint16_t wfio::sint16_t

◆ sint32_t

typedef ::wfio_sint32_t wfio::sint32_t

◆ sint64_t

typedef ::wfio_sint64_t wfio::sint64_t

◆ sint8_t

typedef ::wfio_sint8_t wfio::sint8_t

◆ uint16_t

typedef ::wfio_uint16_t wfio::uint16_t

◆ uint32_t

typedef ::wfio_uint32_t wfio::uint32_t

◆ uint64_t

typedef ::wfio_uint64_t wfio::uint64_t

◆ uint8_t

typedef ::wfio_uint8_t wfio::uint8_t

◆ undefined_t

typedef ::wfio_undefined_t wfio::undefined_t

A structure indicating no definition.

This structure exists as a stand-in for types that cannot be defined. It is intended to facilitate

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
NPOS

Function Documentation

◆ convertEndian() [1/18]

void wfio::convertEndian	(	const wfio::sint16_t *	src,
		wfio::endian_t	srcEndian,
		wfio::sint16_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 16-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 16-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [2/18]

void wfio::convertEndian	(	wfio::sint16_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 16-bit signed integers in buf.

This function can be used to convert the endianness of a vector of 16-bit signed integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [3/18]

wfio_sint16_t wfio::convertEndian	(	wfio::sint16_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 16-bit signed integer.

This function can be used to convert the endianness of a 16-bit signed integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ convertEndian() [4/18]

void wfio::convertEndian	(	const wfio::uint16_t *	src,
		wfio::endian_t	srcEndian,
		wfio::uint16_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 16-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 16-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [5/18]

void wfio::convertEndian	(	wfio::uint16_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 16-bit unsigned integers in buf.

This function can be used to convert the endianness of a vector of 16-bit unsigned integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [6/18]

wfio_uint16_t wfio::convertEndian	(	wfio::uint16_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 16-bit unsigned integer.

This function can be used to convert the endianness of a 16-bit unsigned integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ convertEndian() [7/18]

void wfio::convertEndian	(	const wfio::sint32_t *	src,
		wfio::endian_t	srcEndian,
		wfio::sint32_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 32-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 32-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [8/18]

void wfio::convertEndian	(	wfio::sint32_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 32-bit signed integers in buf.

This function can be used to convert the endianness of a vector of 32-bit signed integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [9/18]

wfio_sint32_t wfio::convertEndian	(	wfio::sint32_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 32-bit signed integer.

This function can be used to convert the endianness of a 32-bit signed integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ convertEndian() [10/18]

void wfio::convertEndian	(	const wfio::uint32_t *	src,
		wfio::endian_t	srcEndian,
		wfio::uint32_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 32-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 32-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [11/18]

void wfio::convertEndian	(	wfio::uint32_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 32-bit unsigned integers in buf.

This function can be used to convert the endianness of a vector of 32-bit unsigned integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [12/18]

wfio_uint32_t wfio::convertEndian	(	wfio::uint32_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 32-bit unsigned integer.

This function can be used to convert the endianness of a 32-bit unsigned integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ convertEndian() [13/18]

void wfio::convertEndian	(	const wfio::sint64_t *	src,
		wfio::endian_t	srcEndian,
		wfio::sint64_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 64-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 64-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [14/18]

void wfio::convertEndian	(	wfio::sint64_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 64-bit signed integers in buf.

This function can be used to convert the endianness of a vector of 64-bit signed integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [15/18]

wfio_sint64_t wfio::convertEndian	(	wfio::sint64_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 64-bit signed integer.

This function can be used to convert the endianness of a 64-bit signed integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ convertEndian() [16/18]

void wfio::convertEndian	(	const wfio::uint64_t *	src,
		wfio::endian_t	srcEndian,
		wfio::uint64_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 64-bit signed integers in src to be stored in dest.

This function can be used to convert the endianness of a vector of 64-bit signed integers. If the source and destination are different, then the

Parameters

src	An array of integers to read from.
srcEndian	The endianness of the source vector.
dest	An array of integers to write to.
destEndian	The desired endianness of the destination vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ convertEndian() [17/18]

void wfio::convertEndian	(	wfio::uint64_t *	buf,
		wfio::endian_t	src,
		wfio::endian_t	dest,
		size_t	len
	)
throw	(
	)

inline

Perform endianness conversion on 64-bit unsigned integers in buf.

This function can be used to convert the endianness of a vector of 64-bit unsigned integers. The conversion occurs in place.

Parameters

buf	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.
len	The number of integers to process.

Precondition: buf is not null

Postcondition: The values in buf shall have their endiannes converted from the values originally passed.

◆ convertEndian() [18/18]

wfio_uint64_t wfio::convertEndian	(	wfio::uint64_t	x,
		wfio::endian_t	src,
		wfio::endian_t	dest
	)
throw	(
	)

inline

Perform endianness conversion on a 64-bit unsigned integer.

This function can be used to convert the endianness of a 64-bit unsigned integer.

Parameters

x	An array of integers to convert the endianess of.
src	The current endianness of the `buf`.
dest	The desired endianness of the `buf`.

Returns: The converted value of x.

◆ fromHostEndian() [1/18]

void wfio::fromHostEndian	(	const wfio::sint16_t *	src,
		wfio::sint16_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit signed integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [2/18]

void wfio::fromHostEndian	(	wfio::sint16_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit signed integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [3/18]

wfio_sint16_t wfio::fromHostEndian	(	wfio::sint16_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 16-bit signed integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ fromHostEndian() [4/18]

void wfio::fromHostEndian	(	const wfio::uint16_t *	src,
		wfio::uint16_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit unsigned integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [5/18]

void wfio::fromHostEndian	(	wfio::uint16_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit unsigned integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [6/18]

wfio_uint16_t wfio::fromHostEndian	(	wfio::uint16_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 16-bit unsigned integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ fromHostEndian() [7/18]

void wfio::fromHostEndian	(	const wfio::sint32_t *	src,
		wfio::sint32_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit signed integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [8/18]

void wfio::fromHostEndian	(	wfio::sint32_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit signed integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [9/18]

wfio_sint32_t wfio::fromHostEndian	(	wfio::sint32_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 32-bit signed integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ fromHostEndian() [10/18]

void wfio::fromHostEndian	(	const wfio::uint32_t *	src,
		wfio::uint32_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit unsigned integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [11/18]

void wfio::fromHostEndian	(	wfio::uint32_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit unsigned integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [12/18]

wfio_uint32_t wfio::fromHostEndian	(	wfio::uint32_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 32-bit unsigned integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ fromHostEndian() [13/18]

void wfio::fromHostEndian	(	const wfio::sint64_t *	src,
		wfio::sint64_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit signed integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [14/18]

void wfio::fromHostEndian	(	wfio::sint64_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit signed integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [15/18]

wfio_sint64_t wfio::fromHostEndian	(	wfio::sint64_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 64-bit signed integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ fromHostEndian() [16/18]

void wfio::fromHostEndian	(	const wfio::uint64_t *	src,
		wfio::uint64_t *	dest,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit unsigned integers in src from the host endianness to that of destEndian and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [17/18]

void wfio::fromHostEndian	(	wfio::uint64_t *	buf,
		wfio::endian_t	destEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit unsigned integers in buf from the host endianness to that of destEndian.

Parameters

buf	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in dest shall be in the destination endianness.

◆ fromHostEndian() [18/18]

wfio_uint64_t wfio::fromHostEndian	(	wfio::uint64_t	x,
		wfio::endian_t	destEndian
	)
throw	(
	)

inline

Convert a 64-bit unsigned integers from the host endianness to that of dest.

Parameters

x	An array of integers to convert.
dest	An array of integers to write to.
destEndian	The desired endianness of `dest`.

Returns: The converted value of x.

◆ toHostEndian() [1/18]

void wfio::toHostEndian	(	const wfio::sint16_t *	src,
		wfio::sint16_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit signed integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [2/18]

void wfio::toHostEndian	(	wfio::sint16_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit signed integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [3/18]

wfio_sint16_t wfio::toHostEndian	(	wfio::sint16_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 16-bit signed integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

◆ toHostEndian() [4/18]

void wfio::toHostEndian	(	const wfio::uint16_t *	src,
		wfio::uint16_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit unsigned integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [5/18]

void wfio::toHostEndian	(	wfio::uint16_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 16-bit unsigned integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [6/18]

wfio_uint16_t wfio::toHostEndian	(	wfio::uint16_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 16-bit unsigned integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

◆ toHostEndian() [7/18]

void wfio::toHostEndian	(	const wfio::sint32_t *	src,
		wfio::sint32_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit signed integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [8/18]

void wfio::toHostEndian	(	wfio::sint32_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit signed integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [9/18]

wfio_sint32_t wfio::toHostEndian	(	wfio::sint32_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 32-bit signed integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

◆ toHostEndian() [10/18]

void wfio::toHostEndian	(	const wfio::uint32_t *	src,
		wfio::uint32_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit unsigned integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [11/18]

void wfio::toHostEndian	(	wfio::uint32_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 32-bit unsigned integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [12/18]

wfio_uint32_t wfio::toHostEndian	(	wfio::uint32_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 32-bit unsigned integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

◆ toHostEndian() [13/18]

void wfio::toHostEndian	(	const wfio::sint64_t *	src,
		wfio::sint64_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit signed integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [14/18]

void wfio::toHostEndian	(	wfio::sint64_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit signed integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [15/18]

wfio_sint64_t wfio::toHostEndian	(	wfio::sint64_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 64-bit signed integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

◆ toHostEndian() [16/18]

void wfio::toHostEndian	(	const wfio::uint64_t *	src,
		wfio::uint64_t *	dest,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit unsigned integers in src from srcEndian to that of the host and store them in dest.

Parameters

src	An array of integers to read from.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: Neither src or dest are null.

Postcondition: The values in dest shall be in the host endianness.

◆ toHostEndian() [17/18]

void wfio::toHostEndian	(	wfio::uint64_t *	buf,
		wfio::endian_t	srcEndian,
		size_t	len
	)
throw	(
	)

inline

Convert 64-bit unsigned integers in buf from srcEndian to that of the host.

Parameters

buf	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.
len	The number of integers to process.

Precondition: buf is not null.

Postcondition: The values in buf shall be in the host endianness.

◆ toHostEndian() [18/18]

wfio_uint64_t wfio::toHostEndian	(	wfio::uint64_t	x,
		wfio::endian_t	srcEndian
	)
throw	(
	)

inline

Convert a 64-bit unsigned integer from src to that of the host.

Parameters

x	An array of integers to read convert.
dest	An array of integers to write to.
srcEndian	The endianness of the source vector.

Returns: The converted value of x.

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ endian_t

◆ fd_t

◆ off_t

◆ sint16_t

◆ sint32_t

◆ sint64_t

◆ sint8_t

◆ uint16_t

◆ uint32_t

◆ uint64_t

◆ uint8_t

◆ undefined_t

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ convertEndian() [1/18]

◆ convertEndian() [2/18]

◆ convertEndian() [3/18]

◆ convertEndian() [4/18]

◆ convertEndian() [5/18]

◆ convertEndian() [6/18]

◆ convertEndian() [7/18]

◆ convertEndian() [8/18]

◆ convertEndian() [9/18]

◆ convertEndian() [10/18]

◆ convertEndian() [11/18]

◆ convertEndian() [12/18]

◆ convertEndian() [13/18]

◆ convertEndian() [14/18]

◆ convertEndian() [15/18]

◆ convertEndian() [16/18]

◆ convertEndian() [17/18]

◆ convertEndian() [18/18]

◆ fromHostEndian() [1/18]

◆ fromHostEndian() [2/18]

◆ fromHostEndian() [3/18]

◆ fromHostEndian() [4/18]

◆ fromHostEndian() [5/18]

◆ fromHostEndian() [6/18]

◆ fromHostEndian() [7/18]

◆ fromHostEndian() [8/18]

◆ fromHostEndian() [9/18]

◆ fromHostEndian() [10/18]

◆ fromHostEndian() [11/18]

◆ fromHostEndian() [12/18]

◆ fromHostEndian() [13/18]

◆ fromHostEndian() [14/18]

◆ fromHostEndian() [15/18]

◆ fromHostEndian() [16/18]

◆ fromHostEndian() [17/18]

◆ fromHostEndian() [18/18]

◆ toHostEndian() [1/18]

◆ toHostEndian() [2/18]

◆ toHostEndian() [3/18]

◆ toHostEndian() [4/18]

◆ toHostEndian() [5/18]

◆ toHostEndian() [6/18]

◆ toHostEndian() [7/18]

◆ toHostEndian() [8/18]

◆ toHostEndian() [9/18]

◆ toHostEndian() [10/18]

◆ toHostEndian() [11/18]

◆ toHostEndian() [12/18]

◆ toHostEndian() [13/18]

◆ toHostEndian() [14/18]

◆ toHostEndian() [15/18]

◆ toHostEndian() [16/18]

◆ toHostEndian() [17/18]

◆ toHostEndian() [18/18]