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

#include <asioext/thread_pool_file_service.hpp>

Inheritance diagram for asioext::thread_pool_file_service:

Public Types
typedef implementation_defined	native_handle_type
	The native handle type. More...

typedef implementation_defined	implementation_type
	The type of a file implementation. More...

Public Member Functions
	thread_pool_file_service (asio::io_service &io_service, std::size_t num_threads=1)

void	shutdown_service ()
	Destroy all user-defined handler objects owned by the service. More...

void	construct (implementation_type &impl)
	Construct a new file implementation. More...

void	move_construct (implementation_type &impl, implementation_type &other_impl) noexcept
	Move-construct a new file implementation. More...

void	move_assign (implementation_type &impl, thread_pool_file_service &other_service, implementation_type &other_impl)
	Move-assign from another file implementation. More...

void	destroy (implementation_type &impl)
	Destroy a file implementation. More...

void	open (implementation_type &impl, const char *filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a handle to the given file. More...

void	open (implementation_type &impl, const wchar_t *filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a handle to the given file. More...

void	open (implementation_type &impl, const boost::filesystem::path &filename, open_flags flags, file_perms perms, file_attrs attrs, error_code &ec) noexcept
	Open a handle to the given file. More...

void	assign (implementation_type &impl, const native_handle_type &handle, error_code &ec) noexcept
	Assign a native handle to a file implementation. More...

bool	is_open (const implementation_type &impl) const noexcept
	Determine whether the file handle is open. More...

void	close (implementation_type &impl, error_code &ec) noexcept
	Destroy a file implementation. More...

native_handle_type	native_handle (implementation_type &impl) noexcept
	Get the native file handle representation. More...

uint64_t	position (implementation_type &impl, error_code &ec) noexcept
	Get the current file pointer position. More...

uint64_t	seek (implementation_type &impl, seek_origin origin, int64_t offset, error_code &ec) noexcept
	Change the current file pointer position. More...

uint64_t	size (implementation_type &impl, error_code &ec) noexcept
	Get the file size. More...

void	size (implementation_type &impl, uint64_t new_size, error_code &ec) noexcept
	Set the file size. More...

file_perms	permissions (implementation_type &impl, error_code &ec) noexcept
	Get the file permissions. More...

void	permissions (implementation_type &impl, file_perms new_perms, error_code &ec) noexcept
	Set the file permissions. More...

void	permissions (implementation_type &impl, file_perms new_perms, file_perm_options opts, error_code &ec) noexcept
	Set the file permissions. More...

file_attrs	attributes (implementation_type &impl, error_code &ec) noexcept
	Get the file attributes. More...

void	attributes (implementation_type &impl, file_attrs new_attrs, error_code &ec) noexcept
	Set the file attributes. More...

void	attributes (implementation_type &impl, file_attrs new_attrs, file_attr_options opts, error_code &ec) noexcept
	Set the file attributes. More...

file_times	times (implementation_type &impl, error_code &ec) noexcept
	Get the file times. More...

void	times (implementation_type &impl, const file_times &new_times, error_code &ec) noexcept
	Set the file times. More...

void	cancel (implementation_type &impl, error_code &ec) noexcept
	Cancel all operations associated with the handle. More...

template<typename MutableBufferSequence >
size_t	read_some (implementation_type &impl, const MutableBufferSequence &buffers, error_code &ec) noexcept
	Read some data. Returns the number of bytes received. More...

template<typename ConstBufferSequence >
size_t	write_some (implementation_type &impl, const ConstBufferSequence &buffers, error_code &ec) noexcept
	Write the given data. Returns the number of bytes written. More...

template<typename MutableBufferSequence >
size_t	read_some_at (implementation_type &impl, uint64_t offset, const MutableBufferSequence &buffers, error_code &ec) noexcept
	Read some data at a specified offset. Returns the number of bytes received. More...

template<typename ConstBufferSequence >
size_t	write_some_at (implementation_type &impl, uint64_t offset, const ConstBufferSequence &buffers, error_code &ec) noexcept

template<typename MutableBufferSequence , typename Handler >
void_or_deduced	async_read_some (implementation_type &impl, const MutableBufferSequence &buffers, Handler &&handler)

template<typename ConstBufferSequence , typename Handler >
void_or_deduced	async_write_some (implementation_type &impl, const ConstBufferSequence &buffers, Handler &&handler)

template<typename MutableBufferSequence , typename Handler >
void_or_deduced	async_read_some_at (implementation_type &impl, uint64_t offset, const MutableBufferSequence &buffers, Handler &&handler)

template<typename ConstBufferSequence , typename Handler >
void_or_deduced	async_write_some_at (implementation_type &impl, uint64_t offset, const ConstBufferSequence &buffers, Handler &&handler)

Static Public Attributes
static asio::io_service::id	id
	The unique service identifier. More...

Detailed Description

A FileService utilizing a thread-pool for async operations.

This FileService class uses a thread-pool to emulate asynchronous file I/O.

Member Typedef Documentation

◆ implementation_type

typedef implementation_defined asioext::thread_pool_file_service::implementation_type

The type of a file implementation.

◆ native_handle_type

typedef implementation_defined asioext::thread_pool_file_service::native_handle_type

The native handle type.

Constructor & Destructor Documentation

◆ thread_pool_file_service()

asioext::thread_pool_file_service::thread_pool_file_service	(	asio::io_service &	io_service,
		std::size_t	num_threads = `1`
	)

explicit

Construct a new file service for the specified io_service.

Parameters

io_service	The io_service that will own this service object.
num_threads	The number of threads that shall be spawned to execute file I/O operations. Defaults to 1.

Member Function Documentation

◆ assign()

void asioext::thread_pool_file_service::assign	(	implementation_type &	impl,
		const native_handle_type &	handle,
		error_code &	ec
	)

noexcept

Assign a native handle to a file implementation.

◆ async_read_some()

template<typename MutableBufferSequence , typename Handler >

void_or_deduced asioext::thread_pool_file_service::async_read_some	(	implementation_type &	impl,
		const MutableBufferSequence &	buffers,
		Handler &&	handler
	)

Start an asynchronous read. The buffer for the data being received must be valid for the lifetime of the asynchronous operation.

◆ async_read_some_at()

template<typename MutableBufferSequence , typename Handler >

void_or_deduced asioext::thread_pool_file_service::async_read_some_at	(	implementation_type &	impl,
		uint64_t	offset,
		const MutableBufferSequence &	buffers,
		Handler &&	handler
	)

Start an asynchronous read at a specified offset. The buffer for the data being received must be valid for the lifetime of the asynchronous operation.

◆ async_write_some()

template<typename ConstBufferSequence , typename Handler >

void_or_deduced asioext::thread_pool_file_service::async_write_some	(	implementation_type &	impl,
		const ConstBufferSequence &	buffers,
		Handler &&	handler
	)

Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.

◆ async_write_some_at()

template<typename ConstBufferSequence , typename Handler >

void_or_deduced asioext::thread_pool_file_service::async_write_some_at	(	implementation_type &	impl,
		uint64_t	offset,
		const ConstBufferSequence &	buffers,
		Handler &&	handler
	)

Start an asynchronous write at a specified offset. The data being written must be valid for the lifetime of the asynchronous operation.

◆ attributes() [1/3]

file_attrs asioext::thread_pool_file_service::attributes	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Get the file attributes.

◆ attributes() [2/3]

void asioext::thread_pool_file_service::attributes	(	implementation_type &	impl,
		file_attrs	new_attrs,
		error_code &	ec
	)

noexcept

Set the file attributes.

◆ attributes() [3/3]

void asioext::thread_pool_file_service::attributes	(	implementation_type &	impl,
		file_attrs	new_attrs,
		file_attr_options	opts,
		error_code &	ec
	)

noexcept

Set the file attributes.

◆ cancel()

void asioext::thread_pool_file_service::cancel	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Cancel all operations associated with the handle.

◆ close()

void asioext::thread_pool_file_service::close	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Destroy a file implementation.

◆ construct()

void asioext::thread_pool_file_service::construct ( implementation_type & impl )

Construct a new file implementation.

◆ destroy()

void asioext::thread_pool_file_service::destroy ( implementation_type & impl )

Destroy a file implementation.

◆ is_open()

bool asioext::thread_pool_file_service::is_open ( const implementation_type & impl ) const

inlinenoexcept

Determine whether the file handle is open.

◆ move_assign()

void asioext::thread_pool_file_service::move_assign	(	implementation_type &	impl,
		thread_pool_file_service &	other_service,
		implementation_type &	other_impl
	)

Move-assign from another file implementation.

◆ move_construct()

void asioext::thread_pool_file_service::move_construct	(	implementation_type &	impl,
		implementation_type &	other_impl
	)

noexcept

Move-construct a new file implementation.

◆ native_handle()

native_handle_type asioext::thread_pool_file_service::native_handle ( implementation_type & impl )

inlinenoexcept

Get the native file handle representation.

◆ open() [1/3]

void asioext::thread_pool_file_service::open	(	implementation_type &	impl,
		const char *	filename,
		open_flags	flags,
		file_perms	perms,
		file_attrs	attrs,
		error_code &	ec
	)

noexcept

Open a handle to the given file.

◆ open() [2/3]

void asioext::thread_pool_file_service::open	(	implementation_type &	impl,
		const wchar_t *	filename,
		open_flags	flags,
		file_perms	perms,
		file_attrs	attrs,
		error_code &	ec
	)

noexcept

Open a handle to the given file.

◆ open() [3/3]

void asioext::thread_pool_file_service::open	(	implementation_type &	impl,
		const boost::filesystem::path &	filename,
		open_flags	flags,
		file_perms	perms,
		file_attrs	attrs,
		error_code &	ec
	)

noexcept

Open a handle to the given file.

◆ permissions() [1/3]

file_perms asioext::thread_pool_file_service::permissions	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Get the file permissions.

◆ permissions() [2/3]

void asioext::thread_pool_file_service::permissions	(	implementation_type &	impl,
		file_perms	new_perms,
		error_code &	ec
	)

noexcept

Set the file permissions.

◆ permissions() [3/3]

void asioext::thread_pool_file_service::permissions	(	implementation_type &	impl,
		file_perms	new_perms,
		file_perm_options	opts,
		error_code &	ec
	)

noexcept

Set the file permissions.

◆ position()

uint64_t asioext::thread_pool_file_service::position	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Get the current file pointer position.

◆ read_some()

template<typename MutableBufferSequence >

size_t asioext::thread_pool_file_service::read_some	(	implementation_type &	impl,
		const MutableBufferSequence &	buffers,
		error_code &	ec
	)

noexcept

Read some data. Returns the number of bytes received.

◆ read_some_at()

template<typename MutableBufferSequence >

size_t asioext::thread_pool_file_service::read_some_at	(	implementation_type &	impl,
		uint64_t	offset,
		const MutableBufferSequence &	buffers,
		error_code &	ec
	)

noexcept

Read some data at a specified offset. Returns the number of bytes received.

◆ seek()

uint64_t asioext::thread_pool_file_service::seek	(	implementation_type &	impl,
		seek_origin	origin,
		int64_t	offset,
		error_code &	ec
	)

noexcept

Change the current file pointer position.

◆ shutdown_service()

void asioext::thread_pool_file_service::shutdown_service ( )

Destroy all user-defined handler objects owned by the service.

◆ size() [1/2]

uint64_t asioext::thread_pool_file_service::size	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Get the file size.

◆ size() [2/2]

void asioext::thread_pool_file_service::size	(	implementation_type &	impl,
		uint64_t	new_size,
		error_code &	ec
	)

noexcept

Set the file size.

◆ times() [1/2]

file_times asioext::thread_pool_file_service::times	(	implementation_type &	impl,
		error_code &	ec
	)

noexcept

Get the file times.

◆ times() [2/2]

void asioext::thread_pool_file_service::times	(	implementation_type &	impl,
		const file_times &	new_times,
		error_code &	ec
	)

noexcept

Set the file times.

◆ write_some()

template<typename ConstBufferSequence >

size_t asioext::thread_pool_file_service::write_some	(	implementation_type &	impl,
		const ConstBufferSequence &	buffers,
		error_code &	ec
	)

noexcept

Write the given data. Returns the number of bytes written.

◆ write_some_at()

template<typename ConstBufferSequence >

size_t asioext::thread_pool_file_service::write_some_at	(	implementation_type &	impl,
		uint64_t	offset,
		const ConstBufferSequence &	buffers,
		error_code &	ec
	)

noexcept

Write the given data at the specified offset. Returns the number of bytes written.

Member Data Documentation

◆ id

asio::io_service::id asioext::thread_pool_file_service::id

static

The unique service identifier.

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ implementation_type

◆ native_handle_type

Constructor & Destructor Documentation

◆ thread_pool_file_service()

Member Function Documentation

◆ assign()

◆ async_read_some()

◆ async_read_some_at()

◆ async_write_some()

◆ async_write_some_at()

◆ attributes() [1/3]

◆ attributes() [2/3]

◆ attributes() [3/3]

◆ cancel()

◆ close()

◆ construct()

◆ destroy()

◆ is_open()

◆ move_assign()

◆ move_construct()

◆ native_handle()

◆ open() [1/3]

◆ open() [2/3]

◆ open() [3/3]

◆ permissions() [1/3]

◆ permissions() [2/3]

◆ permissions() [3/3]

◆ position()

◆ read_some()

◆ read_some_at()

◆ seek()

◆ shutdown_service()

◆ size() [1/2]

◆ size() [2/2]

◆ times() [1/2]

◆ times() [2/2]

◆ write_some()

◆ write_some_at()

Member Data Documentation

◆ id