Logo ROOT  
Reference Guide
BidirMMapPipe_impl::Page Class Reference

class representing the header structure in an mmapped page

Author
Manuel Schiller manue.nosp@m.l.sc.nosp@m.hille.nosp@m.r@ni.nosp@m.khef..nosp@m.nl
Date
2013-07-07

contains a field to put pages into a linked list, a field for the size of the data being transmitted, and a field for the position until which the data has been read

Definition at line 106 of file BidirMMapPipe.cxx.

Public Member Functions

 Page ()
 constructor More...
 
unsigned char * begin () const
 return pointer to first byte in payload data area of page More...
 
bool empty () const
 true if page empty More...
 
unsigned char * end () const
 return pointer to first byte in payload data area of page More...
 
bool filled () const
 true if page partially filled More...
 
unsigned free () const
 free space left (to be written to) More...
 
bool full () const
 true if page completely full More...
 
Pagenext () const
 return pointer to next page More...
 
unsigned shortpos ()
 return reference to position field More...
 
unsigned pos () const
 return position More...
 
unsigned remaining () const
 bytes remaining to be read More...
 
void setNext (const Page *p)
 set pointer to next page More...
 
unsigned shortsize ()
 return reference to size field More...
 
unsigned size () const
 return size (of payload data) More...
 

Static Public Member Functions

static unsigned capacity ()
 return the capacity of the page More...
 

Private Member Functions

 Page (const Page &)
 copy construction forbidden More...
 
Pageoperator= (const Page &)=delete
 assigment forbidden More...
 

Private Attributes

short m_next
 next page in list (in pagesizes) More...
 
unsigned short m_pos
 index of next byte in payload area More...
 
unsigned short m_size
 size of payload (in bytes) More...
 

Constructor & Destructor Documentation

◆ Page() [1/2]

BidirMMapPipe_impl::Page::Page ( const Page )
inlineprivate

copy construction forbidden

Definition at line 115 of file BidirMMapPipe.cxx.

◆ Page() [2/2]

BidirMMapPipe_impl::Page::Page ( )
inline

constructor

Definition at line 120 of file BidirMMapPipe.cxx.

Member Function Documentation

◆ begin()

unsigned char * BidirMMapPipe_impl::Page::begin ( ) const
inline

return pointer to first byte in payload data area of page

Definition at line 140 of file BidirMMapPipe.cxx.

◆ capacity()

static unsigned BidirMMapPipe_impl::Page::capacity ( )
inlinestatic

return the capacity of the page

Definition at line 148 of file BidirMMapPipe.cxx.

◆ empty()

bool BidirMMapPipe_impl::Page::empty ( ) const
inline

true if page empty

Definition at line 151 of file BidirMMapPipe.cxx.

◆ end()

unsigned char * BidirMMapPipe_impl::Page::end ( ) const
inline

return pointer to first byte in payload data area of page

Definition at line 144 of file BidirMMapPipe.cxx.

◆ filled()

bool BidirMMapPipe_impl::Page::filled ( ) const
inline

true if page partially filled

Definition at line 153 of file BidirMMapPipe.cxx.

◆ free()

unsigned BidirMMapPipe_impl::Page::free ( ) const
inline

free space left (to be written to)

Definition at line 155 of file BidirMMapPipe.cxx.

◆ full()

bool BidirMMapPipe_impl::Page::full ( ) const
inline

true if page completely full

Definition at line 159 of file BidirMMapPipe.cxx.

◆ next()

Page * BidirMMapPipe_impl::Page::next ( ) const

return pointer to next page

Definition at line 181 of file BidirMMapPipe.cxx.

◆ operator=()

Page & BidirMMapPipe_impl::Page::operator= ( const Page )
privatedelete

assigment forbidden

◆ pos() [1/2]

unsigned short & BidirMMapPipe_impl::Page::pos ( )
inline

return reference to position field

Definition at line 136 of file BidirMMapPipe.cxx.

◆ pos() [2/2]

unsigned BidirMMapPipe_impl::Page::pos ( ) const
inline

return position

Definition at line 138 of file BidirMMapPipe.cxx.

◆ remaining()

unsigned BidirMMapPipe_impl::Page::remaining ( ) const
inline

bytes remaining to be read

Definition at line 157 of file BidirMMapPipe.cxx.

◆ setNext()

void BidirMMapPipe_impl::Page::setNext ( const Page p)

set pointer to next page

Definition at line 162 of file BidirMMapPipe.cxx.

◆ size() [1/2]

unsigned short & BidirMMapPipe_impl::Page::size ( )
inline

return reference to size field

Definition at line 132 of file BidirMMapPipe.cxx.

◆ size() [2/2]

unsigned BidirMMapPipe_impl::Page::size ( ) const
inline

return size (of payload data)

Definition at line 134 of file BidirMMapPipe.cxx.

Member Data Documentation

◆ m_next

short BidirMMapPipe_impl::Page::m_next
private

next page in list (in pagesizes)

Definition at line 111 of file BidirMMapPipe.cxx.

◆ m_pos

unsigned short BidirMMapPipe_impl::Page::m_pos
private

index of next byte in payload area

Definition at line 113 of file BidirMMapPipe.cxx.

◆ m_size

unsigned short BidirMMapPipe_impl::Page::m_size
private

size of payload (in bytes)

Definition at line 112 of file BidirMMapPipe.cxx.


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