#include <ddcMMap.h>

Inheritance diagram for ddcMMap< T >:

[legend]

Collaboration diagram for ddcMMap< T >:

Public Types
typedef T *	iterator

typedef const T *	const_iterator

Public Member Functions
	ddcMMap ()
	default constructor More...

	ddcMMap (const std::string &filename, int mode=O_RDONLY)

	~ddcMMap ()
	default destructor calls close() More...

const std::string &	filename () const
	returns the name of the currently mapped file, if any More...

size_t	nbytes () const
	returns number of bytes mapped, or 0 More...

T *	data () const
	returns a pointer to the mmap()ed file data, or NULL More...

size_t	size () const
	returns the number of objects of type T mapped, or 0 More...

bool	empty () const
	STL-esque wrapper for (nbytes()==0) More...

bool	opened () const
	returns true iff m_data is non-NULL More...

	operator bool () const
	implicit typecast to bool More...

	operator T* () const
	implicit typecast to T* More...

T &	operator[] (size_t idx) const
	indexing operator More...

ddcMMap &	open (const std::string &filename, int mode=O_RDONLY)
	map a named file filename More...

void	close ()
	unmap current file (if any) More...

iterator	begin () const

iterator	end () const

Public Attributes
std::string	m_file
	underlying filename More...

size_t	m_nbytes
	number of bytes mapped More...

T *	m_data
	file data More...

Detailed Description

template<typename T = char>
class ddcMMap< T >

convenience wrapper for mapping entire files into virtual memory using mmap()

Member Typedef Documentation

◆ iterator

template<typename T = char>

typedef T* ddcMMap< T >::iterator

◆ const_iterator

template<typename T = char>

typedef const T* ddcMMap< T >::const_iterator

Constructor & Destructor Documentation

◆ ddcMMap() [1/2]

template<typename T = char>

ddcMMap< T >::ddcMMap ( )

inline

default constructor

◆ ddcMMap() [2/2]

template<typename T = char>

ddcMMap< T >::ddcMMap	(	const std::string &	filename,
		int	mode = `O_RDONLY`
	)

inline

◆ ~ddcMMap()

template<typename T = char>

ddcMMap< T >::~ddcMMap ( )

inline

default destructor calls close()

Member Function Documentation

◆ filename()

template<typename T = char>

const std::string& ddcMMap< T >::filename ( ) const

inline

returns the name of the currently mapped file, if any

Referenced by ddcVecFile< CIndexItem >::ensureVec(), ddcMMap< CIndexItem >::open(), ddcVecFile< CIndexItem >::open(), and ddcFileOrMMap::operator bool().

Here is the caller graph for this function:

◆ nbytes()

template<typename T = char>

size_t ddcMMap< T >::nbytes ( ) const

inline

returns number of bytes mapped, or 0

Referenced by ddcFileOrMMap::operator bool().

Here is the caller graph for this function:

◆ data()

template<typename T = char>

T* ddcMMap< T >::data ( ) const

inline

returns a pointer to the mmap()ed file data, or NULL

◆ size()

template<typename T = char>

size_t ddcMMap< T >::size ( ) const

inline

returns the number of objects of type T mapped, or 0

Referenced by ddcRecFile::empty(), ddcMapFile< DWORD, DWORD >::empty(), ddcMMap< CIndexItem >::end(), ddcVecFile< CIndexItem >::end(), ddcVecFile< CIndexItem >::ensureVec(), ddcVecFile< CIndexItem >::save(), and ddcVecFile< CIndexItem >::size().

Here is the caller graph for this function:

◆ empty()

template<typename T = char>

bool ddcMMap< T >::empty ( void ) const

inline

STL-esque wrapper for (nbytes()==0)

Referenced by ddcVecFile< CIndexItem >::empty().

Here is the caller graph for this function:

◆ opened()

template<typename T = char>

bool ddcMMap< T >::opened ( ) const

inline

returns true iff m_data is non-NULL

Referenced by ddcMMap< CIndexItem >::open(), ddcVecFile< CIndexItem >::open(), ddcMapFile< DWORD, DWORD >::open(), ddcFileOrMMap::opened(), ddcMMap< CIndexItem >::operator bool(), ddcVecFile< CIndexItem >::operator bool(), ddcRecFile::operator bool(), ddcMapFile< DWORD, DWORD >::operator bool(), and ddcFileOrMMap::operator bool().

Here is the caller graph for this function:

◆ operator bool()

template<typename T = char>

ddcMMap< T >::operator bool ( ) const

inline

implicit typecast to bool

◆ operator T*()

template<typename T = char>

ddcMMap< T >::operator T* ( ) const

inline

implicit typecast to T*

References ddcMMap< T >::m_data.

◆ operator[]()

template<typename T = char>

T& ddcMMap< T >::operator[] ( size_t idx ) const

inline

indexing operator

◆ open()

template<typename T = char>

ddcMMap& ddcMMap< T >::open	(	const std::string &	filename,
		int	mode = `O_RDONLY`
	)

inline

map a named file filename

Referenced by ddcMapFile< DWORD, DWORD >::ddcMapFile(), ddcMMap< CIndexItem >::ddcMMap(), ddcRecFile::ddcRecFile(), ddcVecFile< CIndexItem >::ddcVecFile(), ddcMMap< CIndexItem >::open(), ddcVecFile< CIndexItem >::open(), and ddcFileOrMMap::Open().

Here is the caller graph for this function:

◆ close()

template<typename T = char>

void ddcMMap< T >::close ( void )

inline

unmap current file (if any)

Referenced by ddcVecFile< CIndexItem >::clear(), ddcMapFile< DWORD, DWORD >::clear(), ddcVecFile< CIndexItem >::close(), ddcFileOrMMap::Close(), ddcVecFile< CIndexItem >::ensureVec(), ddcMMap< CIndexItem >::open(), ddcVecFile< CIndexItem >::open(), ddcMapFile< DWORD, DWORD >::open(), ddcMapFile< DWORD, DWORD >::~ddcMapFile(), ddcMMap< CIndexItem >::~ddcMMap(), ddcRecFile::~ddcRecFile(), and ddcVecFile< CIndexItem >::~ddcVecFile().

Here is the caller graph for this function:

◆ begin()

template<typename T = char>

iterator ddcMMap< T >::begin ( ) const

inline

Referenced by ddcMapFile< DWORD, DWORD >::ensureMap(), and ddcMapFile< DWORD, DWORD >::find().

Here is the caller graph for this function:

◆ end()

template<typename T = char>

iterator ddcMMap< T >::end ( ) const

inline

Referenced by ddcMapFile< DWORD, DWORD >::ensureMap(), and ddcMapFile< DWORD, DWORD >::find().

Here is the caller graph for this function:

Member Data Documentation

◆ m_file

template<typename T = char>

std::string ddcMMap< T >::m_file

underlying filename

Referenced by ddcMMap< CIndexItem >::filename(), and ddcVecFile< CIndexItem >::filename().

◆ m_nbytes

template<typename T = char>

size_t ddcMMap< T >::m_nbytes

number of bytes mapped

Referenced by ddcMMap< CIndexItem >::nbytes().

◆ m_data

template<typename T = char>

T* ddcMMap< T >::m_data

file data

Referenced by ddcMMap< CIndexItem >::begin(), ddcVecFile< CIndexItem >::begin(), ddcMMap< CIndexItem >::data(), ddcVecFile< CIndexItem >::data(), ddcVecFile< CIndexItem >::ensureData(), ddcVecFile< CIndexItem >::ensureVec(), ddcVecFile< CIndexItem >::open(), ddcMMap< T >::operator T*(), ddcVecFile< T >::operator T*(), ddcRecFile::operator[](), ddcFileOrMMap::ReadBuffer(), and ddcVecFile< CIndexItem >::save().

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

ddcMMap.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename T = char> class ddcMMap< T >

Member Typedef Documentation

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ ddcMMap() [1/2]

◆ ddcMMap() [2/2]

◆ ~ddcMMap()

Member Function Documentation

◆ filename()

◆ nbytes()

◆ data()

◆ size()

◆ empty()

◆ opened()

◆ operator bool()

◆ operator T*()

◆ operator[]()

◆ open()

◆ close()

◆ begin()

◆ end()

Member Data Documentation

◆ m_file

◆ m_nbytes

◆ m_data

template<typename T = char>
class ddcMMap< T >