mmap_file Class Reference [File implementations]

Implementation of memory mapped access file. More...

#include <mmap_file.h>

Inheritance diagram for mmap_file:

Collaboration diagram for mmap_file:

List of all members.

Public Member Functions
	mmap_file (const std::string &filename, int mode, int disk=-1)
	constructs file object
request_ptr	aread (void *buffer, stxxl::int64 pos, size_t bytes, completion_handler on_cmpl)
	Schedules asynchronous read request to the file.
request_ptr	awrite (void *buffer, stxxl::int64 pos, size_t bytes, completion_handler on_cmpl)
	Schedules asynchronous write request to the file.

---

Detailed Description

Implementation of memory mapped access file.

---

Constructor & Destructor Documentation

mmap_file::mmap_file	(	const std::string &	filename,
		int	mode,
		int	disk = -1
	)			[inline]

constructs file object

Parameters:

	filename	path of file
	mode	open mode, see stxxl::file::open_modes
	disk	disk(file) identifier

---

Member Function Documentation

request_ptr mmap_file::aread	(	void *	buffer,
		stxxl::int64	pos,
		size_t	bytes,
		completion_handler	on_cmpl
	)			[virtual]

Schedules asynchronous read request to the file.

Parameters:

	buffer	pointer to memory buffer to read into
	pos	starting file position to read
	bytes	number of bytes to transfer
	on_cmpl	I/O completion handler

Returns:

request_ptr object, that can be used to track the status of the operation

Implements file.

References request_ptr::get(), and file::get_id().

request_ptr mmap_file::awrite	(	void *	buffer,
		stxxl::int64	pos,
		size_t	bytes,
		completion_handler	on_cmpl
	)			[virtual]

Schedules asynchronous write request to the file.

Parameters:

	buffer	pointer to memory buffer to write from
	pos	starting file position to write
	bytes	number of bytes to transfer
	on_cmpl	I/O completion handler

Returns:

request_ptr object, that can be used to track the status of the operation

Implements file.

References request_ptr::get(), and file::get_id().

---

The documentation for this class was generated from the following files:

• mmap_file.h
• mmap_file.cpp