AsioExt's main namespace. More...

Namespaces
	socks

Classes
class	associated_allocator
	Helper trait to obtain the allocator associated with a handler. More...

struct	async_completion

class	async_result
	An interface for customising the behaviour of an initiating function. More...

class	basic_file
	Basic interface for (a)synchronous file I/O. More...

class	basic_linear_buffer
	A dynamically sized contiguously stored buffer. More...

class	cancellation_token
	Token to determine if an operation was cancelled. More...

class	cancellation_token_source
	Manager for cancellation_tokens. More...

class	composed_operation
	Base class for composed operations. More...

class	dynamic_linear_buffer
	Adapt a `basic_linear_buffer` to the DynamicBuffer requirements. More...

class	file_clock
	Special clock for filesystem time points. More...

class	file_handle
	A thin and lightweight wrapper around a native file handle. More...

struct	file_times
	Container for various times associated with a file. More...

class	hook_allocator
	Allocator that uses a handler's memory allocation hooks. More...

struct	is_raw_byte_container
	Determines whether T satisfies the RawByteContainer requirements. More...

class	thread_pool_file_service
	A FileService utilizing a thread-pool for async operations. More...

class	unique_file_handle
	RAII wrapper around file_handle. More...

Typedefs
template<typename Handler >
using	associated_allocator_t = typename associated_allocator< Handler >::type
	Alias for associated_allocator::type. More...

template<typename CompletionToken , typename Signature >
using	async_result_t = typename async_result< typename std::decay< CompletionToken >::type, Signature >::return_type
	An initiating function's return type. More...

template<typename CompletionToken , typename Signature >
using	completion_handler_t = typename async_result< typename std::decay< CompletionToken >::type, Signature >::completion_handler_type
	The real handler type to be used for the asynchronous operation. More...

typedef chrono::time_point< file_clock >	file_time_type
	Representation of a file time (e.g. mtime) More...

typedef automatically_chosen	error_code
	Typedef for the error_code class used by this library. More...

typedef automatically_chosen	error_category
	Either `boost::system::error_category` or `std::error_category`. More...

typedef automatically_chosen	system_category
	Either `boost::system::system_category` or `std::system_category`. More...

typedef automatically_chosen	generic_category
	Either `boost::system::generic_category` or `std::generic_category`. More...

typedef automatically_chosen	errc
	Either `boost::system::errc` or `std::errc`. More...

typedef basic_file< thread_pool_file_service >	file

typedef basic_linear_buffer	linear_buffer
	A linear buffer using the default allocator. More...

typedef unique_file_handle	scoped_file_handle
	(Deprecated) Alias for `unique_file_handle` More...

Enumerations
enum	open_flags { open_flags::none = 0, open_flags::access_read = 1 << 0, open_flags::access_write = 1 << 1, open_flags::access_read_write = access_read \| access_write, open_flags::create_new = 1 << 2, open_flags::create_always = 1 << 3, open_flags::open_existing = 1 << 4, open_flags::open_always = 1 << 5, open_flags::truncate_existing = 1 << 6, open_flags::exclusive_read = 1 << 7, open_flags::exclusive_write = 1 << 8 }
	Specifies semantics for opening files. More...

enum	seek_origin { seek_origin::from_begin, seek_origin::from_current, seek_origin::from_end }
	Specifies the various position offset origins. More...


enum	file_attrs : uint32_t { file_attrs::none = 0, file_attrs::hidden = 1 << 0, file_attrs::system = 1 << 1, file_attrs::archive = 1 << 2, file_attrs::no_dump = 1 << 3, file_attrs::not_indexed = 1 << 4, file_attrs::user_immutable = 1 << 5, file_attrs::system_immutable = 1 << 6, file_attrs::user_no_unlink = 1 << 7, file_attrs::system_no_unlink = 1 << 8 }
	Names for file attributes. More...

enum	file_attr_options { file_attr_options::none = 0, file_attr_options::replace = 1 << 0, file_attr_options::add = 1 << 1, file_attr_options::remove = 1 << 2 }
	Options to control the behavior of asioext::file_handle::attributes(file_attrs,file_attr_options) More...


enum	file_perms { file_perms::none = 0, file_perms::owner_read = 0400, file_perms::owner_write = 0200, file_perms::owner_exec = 0100, file_perms::owner_all = 0700, file_perms::group_read = 040, file_perms::group_write = 020, file_perms::group_exec = 010, file_perms::group_all = 070, file_perms::others_read = 04, file_perms::others_write = 02, file_perms::others_exec = 01, file_perms::others_all = 07, file_perms::all = 0777, file_perms::set_uid = 04000, file_perms::set_gid = 02000, file_perms::sticky_bit = 01000, file_perms::create_default = 0666, file_perms::mask = 07777, file_perms::unknown = 0xFFFF }
	Names for permissions. More...

enum	file_perm_options { file_perm_options::none = 0, file_perm_options::replace = 1 << 0, file_perm_options::add = 1 << 1, file_perm_options::remove = 1 << 2 }
	Options to control the behavior of asioext::file_handle::permissions(file_perms,file_perm_options) More...

Functions
template<typename Handler , class T , class U >
bool	operator== (const hook_allocator< T, Handler > &a, const hook_allocator< U, Handler > &b) noexcept

template<typename Handler , class T , class U >
bool	operator!= (const hook_allocator< T, Handler > &a, const hook_allocator< U, Handler > &b) noexcept

template<typename Handler >
associated_allocator< Handler >::type	get_associated_allocator (Handler &handler) noexcept
	Get the handler's associated allocator. More...

template<typename Handler , typename... Args>
implementation_defined	bind_handler (Handler &&handler, Args &&... args)
	Bind values to a Handler's arguments to create a CompletionHandler. More...

void	connect (asio::ip::tcp::socket::lowest_layer_type &socket, asio::ip::tcp::resolver &resolver, const asio::ip::tcp::resolver::query &q)
	Establishes a socket connection by trying each endpoint of a resolved name. More...

void	connect (asio::ip::tcp::socket::lowest_layer_type &socket, asio::ip::tcp::resolver &resolver, const asio::ip::tcp::resolver::query &q, error_code &ec)
	Establishes a socket connection by trying each endpoint of a name. More...

template<typename ComposedConnectHandler >
void_or_deduced	async_connect (asio::ip::tcp::socket::lowest_layer_type &socket, asio::ip::tcp::resolver &resolver, const asio::ip::tcp::resolver::query &q, ComposedConnectHandler &&handler)
	Asynchronously establishe a socket connection by trying each endpoint of a resolved name. More...

unique_file_handle	duplicate (file_handle handle)
	Duplicate the given file_handle's native handle. More...

unique_file_handle	duplicate (file_handle handle, error_code &ec) noexcept
	Duplicate the given file_handle's native handle. More...

bool	operator== (const file_times &a, const file_times &b)

bool	operator!= (const file_times &a, const file_times &b)

template<typename Allocator >
asio::const_buffers_1	buffer (const basic_linear_buffer< Allocator > &b) noexcept

template<typename Allocator >
asio::mutable_buffers_1	buffer (basic_linear_buffer< Allocator > &b) noexcept

template<typename Allocator >
dynamic_linear_buffer< Allocator >	dynamic_buffer (basic_linear_buffer< Allocator > &data) noexcept
	Create a new dynamic buffer that represents the given `basic_linear_buffer`. More...

unique_file_handle	open (const char *filename, open_flags flags, file_perms perms=file_perms::create_default, file_attrs attrs=file_attrs::none)
	Open a file and return its handle. More...

unique_file_handle	open (const char *filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a file and return its handle. More...

unique_file_handle	open (const wchar_t *filename, open_flags flags, file_perms perms=file_perms::create_default, file_attrs attrs=file_attrs::none)
	Open a file and return its handle. More...

unique_file_handle	open (const wchar_t *filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a file and return its handle. More...

unique_file_handle	open (const boost::filesystem::path &filename, open_flags flags, file_perms perms=file_perms::create_default, file_attrs attrs=file_attrs::none)
	Open a file and return its handle. More...

unique_file_handle	open (const boost::filesystem::path &filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a file and return its handle. More...

bool	is_valid (open_flags flags) noexcept
	Check whether a set of open flags is valid. More...

file_handle	get_stdin ()
	Get a handle to the standard input. More...

file_handle	get_stdin (error_code &ec) noexcept
	Get a handle to the standard input. More...

file_handle	get_stdout ()
	Get a handle to the standard output. More...

file_handle	get_stdout (error_code &ec) noexcept
	Get a handle to the standard output. More...

file_handle	get_stderr ()
	Get a handle to the standard error. More...

file_handle	get_stderr (error_code &ec) noexcept
	Get a handle to the standard error. More...

template<class ConstBufferSequence >
void	write_file (const char *filename, const ConstBufferSequence &buffers)

template<class ConstBufferSequence >
void	write_file (const char *filename, const ConstBufferSequence &buffers, error_code &ec) noexcept

template<class ConstBufferSequence >
void	write_file (const wchar_t *filename, const ConstBufferSequence &buffers)

template<class ConstBufferSequence >
void	write_file (const wchar_t *filename, const ConstBufferSequence &buffers, error_code &ec) noexcept

template<class ConstBufferSequence >
void	write_file (const boost::filesystem::path &filename, const ConstBufferSequence &buffers)

template<class ConstBufferSequence >
void	write_file (const boost::filesystem::path &filename, const ConstBufferSequence &buffers, error_code &ec) noexcept

RawByteContainer overloads
See RawByteContainer for RawByteContainer requirements.
template<class RawByteContainer >
void	read_file (const char *filename, RawByteContainer &c)

template<class RawByteContainer >
void	read_file (const char *filename, RawByteContainer &c, error_code &ec)

template<class RawByteContainer >
void	read_file (const wchar_t *filename, RawByteContainer &c)

template<class RawByteContainer >
void	read_file (const wchar_t *filename, RawByteContainer &c, error_code &ec)

template<class RawByteContainer >
void	read_file (const boost::filesystem::path &filename, RawByteContainer &c)

template<class RawByteContainer >
void	read_file (const boost::filesystem::path &filename, RawByteContainer &c, error_code &ec)

template<class RawByteContainer >
void	read_file (file_handle file, RawByteContainer &c)

template<class RawByteContainer >
void	read_file (file_handle file, RawByteContainer &c, error_code &ec) noexcept

MutableBufferSequence overloads
template<class MutableBufferSequence >
void	read_file (const char *filename, const MutableBufferSequence &buffers)

template<class MutableBufferSequence >
void	read_file (const char *filename, const MutableBufferSequence &buffers, error_code &ec) noexcept

template<class MutableBufferSequence >
void	read_file (const wchar_t *filename, const MutableBufferSequence &buffers)

template<class MutableBufferSequence >
void	read_file (const wchar_t *filename, const MutableBufferSequence &buffers, error_code &ec) noexcept

template<class MutableBufferSequence >
void	read_file (const boost::filesystem::path &filename, const MutableBufferSequence &buffers)

template<class MutableBufferSequence >
void	read_file (const boost::filesystem::path &filename, const MutableBufferSequence &buffers, error_code &ec) noexcept

template<class MutableBufferSequence >
void	read_file (file_handle file, const MutableBufferSequence &buffers)

template<class MutableBufferSequence >
void	read_file (file_handle file, const MutableBufferSequence &buffers, error_code &ec) noexcept

Detailed Description

AsioExt's main namespace.

Copyright: Copyright (c) 2018 Tim Niederhausen (tim@r.nosp@m.nc-a.nosp@m.g.de) Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt); Copyright (c) 2017 Tim Niederhausen (tim@r.nosp@m.nc-a.nosp@m.g.de) Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt); Copyright (c) 2015 Tim Niederhausen (tim@r.nosp@m.nc-a.nosp@m.g.de) Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Typedef Documentation

◆ linear_buffer

typedef basic_linear_buffer asioext::linear_buffer

A linear buffer using the default allocator.

◆ scoped_file_handle

typedef unique_file_handle asioext::scoped_file_handle

(Deprecated) Alias for unique_file_handle

Function Documentation

◆ buffer() [1/2]

template<typename Allocator >

asio::const_buffers_1 asioext::buffer ( const basic_linear_buffer< Allocator > & b )

inlinenoexcept

◆ buffer() [2/2]

template<typename Allocator >

asio::mutable_buffers_1 asioext::buffer ( basic_linear_buffer< Allocator > & b )

inlinenoexcept

◆ operator!=() [1/2]

bool asioext::operator!=	(	const file_times &	a,
		const file_times &	b
	)

inline

◆ operator!=() [2/2]

template<typename Handler , class T , class U >

bool asioext::operator!=	(	const hook_allocator< T, Handler > &	a,
		const hook_allocator< U, Handler > &	b
	)

noexcept

◆ operator==() [1/2]

bool asioext::operator==	(	const file_times &	a,
		const file_times &	b
	)