μHAL (v2.7.9)
Part of the IPbus software repository
Public Member Functions | Private Attributes | List of all members
uhal::Mmap::File Class Reference

Public Member Functions

 File (const std::string &aPath, int aFlags)
 
 ~File ()
 
const std::string & getPath () const
 
void setPath (const std::string &aPath)
 
void setOffset (size_t aOffset)
 
void open ()
 
void close ()
 
void read (const uint32_t aAddr, const uint32_t aNrWords, std::vector< uint32_t > &aValues)
 
void write (const uint32_t aAddr, const std::vector< std::pair< const uint8_t *, size_t > > &aData)
 

Private Attributes

std::string mPath
 
int mFd
 
int mFlags
 
off_t mOffset
 
void * mMmapPtr
 
void * mMmapIOPtr
 

Detailed Description

Definition at line 96 of file ProtocolMmap.hpp.

Constructor & Destructor Documentation

◆ File()

uhal::Mmap::File::File ( const std::string &  aPath,
int  aFlags 
)

Definition at line 110 of file ProtocolMmap.cpp.

◆ ~File()

uhal::Mmap::File::~File ( )

Definition at line 121 of file ProtocolMmap.cpp.

Member Function Documentation

◆ close()

void uhal::Mmap::File::close ( )

Definition at line 175 of file ProtocolMmap.cpp.

References uhal::Error, uhal::Integer(), uhal::log(), MAP_SIZE, and uhal::Quote().

Referenced by uhal::Mmap::disconnect().

◆ getPath()

const std::string & uhal::Mmap::File::getPath ( ) const

Definition at line 127 of file ProtocolMmap.cpp.

Referenced by uhal::Mmap::connect(), uhal::Mmap::read(), and uhal::Mmap::write().

◆ open()

void uhal::Mmap::File::open ( )

Definition at line 149 of file ProtocolMmap.cpp.

References uhal::Integer(), uhal::log(), MAP_SIZE, and uhal::Quote().

◆ read()

void uhal::Mmap::File::read ( const uint32_t  aAddr,
const uint32_t  aNrWords,
std::vector< uint32_t > &  aValues 
)

Definition at line 195 of file ProtocolMmap.cpp.

Referenced by uhal::Mmap::connect(), and uhal::Mmap::read().

◆ setOffset()

void uhal::Mmap::File::setOffset ( size_t  aOffset)

Definition at line 139 of file ProtocolMmap.cpp.

Referenced by uhal::Mmap::Mmap().

◆ setPath()

void uhal::Mmap::File::setPath ( const std::string &  aPath)

Definition at line 133 of file ProtocolMmap.cpp.

◆ write()

void uhal::Mmap::File::write ( const uint32_t  aAddr,
const std::vector< std::pair< const uint8_t *, size_t > > &  aData 
)

Definition at line 208 of file ProtocolMmap.cpp.

References uhal::Integer(), and uhal::log().

Referenced by uhal::Mmap::write().

Member Data Documentation

◆ mFd

int uhal::Mmap::File::mFd
private

Definition at line 115 of file ProtocolMmap.hpp.

◆ mFlags

int uhal::Mmap::File::mFlags
private

Definition at line 116 of file ProtocolMmap.hpp.

◆ mMmapIOPtr

void* uhal::Mmap::File::mMmapIOPtr
private

Definition at line 119 of file ProtocolMmap.hpp.

◆ mMmapPtr

void* uhal::Mmap::File::mMmapPtr
private

Definition at line 118 of file ProtocolMmap.hpp.

◆ mOffset

off_t uhal::Mmap::File::mOffset
private

Definition at line 117 of file ProtocolMmap.hpp.

◆ mPath

std::string uhal::Mmap::File::mPath
private

Definition at line 114 of file ProtocolMmap.hpp.


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