memory_mapped_file Class Reference
[File System Library]

#include <unixstl/filesystem/memory_mapped_file.hpp>

List of all members.

---

Detailed Description

Facade over the UNIX memory mapped file API.

Member Types
typedef memory_mapped_file	class_type
	This type.
typedef us_uint32_t	size_type
	The size type.
typedef int	error_type
	The error type.
typedef off_t	offset_type
	The offset type.
typedef bool	bool_type
	The boolean type.
Public Member Functions
Construction
	memory_mapped_file (char_type const *fileName)
template<typename S>
	memory_mapped_file (S const &fileName)
	memory_mapped_file (char_type const *fileName, offset_type offset, size_type requestSize)
template<typename S>
	memory_mapped_file (S const &fileName, offset_type offset, size_type requestSize)
	~memory_mapped_file () throw ()
	Closes the view on the mapped file.
void	swap (class_type &rhs) throw ()
	Swaps the state of this instance with another.
Accessors
void const *	memory () const
	Non-mutating (const) pointer to the start of the mapped region.
size_type	size () const
	The number of bytes in the mapped region.

---

Member Typedef Documentation

typedef memory_mapped_file class_type

This type.

typedef us_uint32_t size_type

The size type.

typedef int error_type

The error type.

typedef off_t offset_type

The offset type.

typedef bool bool_type

The boolean type.

---

Constructor & Destructor Documentation

~memory_mapped_file

(

)

throw () [inline]

Closes the view on the mapped file.

References UNIXSTL_ASSERT.

---

Member Function Documentation

void swap

(

class_type &

rhs

)

throw () [inline]

Swaps the state of this instance with another.

References stlsoft::std_swap(), and UNIXSTL_ASSERT.

void const* memory

(

)

const [inline]

Non-mutating (const) pointer to the start of the mapped region.

size_type size

(

)

const [inline]

The number of bytes in the mapped region.

---

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

• unixstl/filesystem/memory_mapped_file.hpp