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 107 of file BidirMMapPipe.cxx.

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

Static Public Member Functions
static unsigned	capacity ()
	return the capacity of the page

Private Member Functions
	Page (const Page &)
	copy construction forbidden
Page &	operator= (const Page &)=delete
	assigment forbidden

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

Constructor & Destructor Documentation

Page() [1/2]

BidirMMapPipe_impl::Page::Page ( const Page &  )

inlineprivate

copy construction forbidden

Definition at line 116 of file BidirMMapPipe.cxx.

Page() [2/2]

BidirMMapPipe_impl::Page::Page ( )

inline

constructor

Definition at line 121 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 141 of file BidirMMapPipe.cxx.

capacity()

static unsigned BidirMMapPipe_impl::Page::capacity ( )

inlinestatic

return the capacity of the page

Definition at line 149 of file BidirMMapPipe.cxx.

empty()

bool BidirMMapPipe_impl::Page::empty ( ) const

inline

true if page empty

Definition at line 152 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 145 of file BidirMMapPipe.cxx.

filled()

bool BidirMMapPipe_impl::Page::filled ( ) const

inline

true if page partially filled

Definition at line 154 of file BidirMMapPipe.cxx.

free()

unsigned BidirMMapPipe_impl::Page::free ( ) const

inline

free space left (to be written to)

Definition at line 156 of file BidirMMapPipe.cxx.

full()

bool BidirMMapPipe_impl::Page::full ( ) const

inline

true if page completely full

Definition at line 160 of file BidirMMapPipe.cxx.

next()

Page * BidirMMapPipe_impl::Page::next

(

)

const

return pointer to next page

Definition at line 182 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 137 of file BidirMMapPipe.cxx.

pos() [2/2]

unsigned BidirMMapPipe_impl::Page::pos ( ) const

inline

return position

Definition at line 139 of file BidirMMapPipe.cxx.

remaining()

unsigned BidirMMapPipe_impl::Page::remaining ( ) const

inline

bytes remaining to be read

Definition at line 158 of file BidirMMapPipe.cxx.

setNext()

void BidirMMapPipe_impl::Page::setNext

(

const Page *

p

)

set pointer to next page

Definition at line 163 of file BidirMMapPipe.cxx.

size() [1/2]

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

inline

return reference to size field

Definition at line 133 of file BidirMMapPipe.cxx.

size() [2/2]

unsigned BidirMMapPipe_impl::Page::size ( ) const

inline

return size (of payload data)

Definition at line 135 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 112 of file BidirMMapPipe.cxx.

m_pos

unsigned short BidirMMapPipe_impl::Page::m_pos

private

index of next byte in payload area

Definition at line 114 of file BidirMMapPipe.cxx.

m_size

unsigned short BidirMMapPipe_impl::Page::m_size

private

size of payload (in bytes)

Definition at line 113 of file BidirMMapPipe.cxx.