Fawkes API  Fawkes Development Version
fawkes::BlackBoardSharedMemoryLister Class Reference

BlackBoard shared memory lister. More...

#include <>>

Inheritance diagram for fawkes::BlackBoardSharedMemoryLister:

Public Member Functions

 BlackBoardSharedMemoryLister ()
 Constructor. More...
 
virtual ~BlackBoardSharedMemoryLister ()
 Destructor. More...
 
virtual void print_header ()
 Print header of the table. More...
 
virtual void print_footer ()
 Print footer of the table. More...
 
virtual void print_no_segments ()
 Print this if no matching segment was found. More...
 
virtual void print_no_orphaned_segments ()
 Print this if no matching orphaned segment was found. More...
 
virtual void print_info (const SharedMemoryHeader *header, int shm_id, int semaphore, unsigned int mem_size, const void *memptr)
 Print info about segment. More...
 
- Public Member Functions inherited from fawkes::SharedMemoryLister
virtual ~SharedMemoryLister ()
 virtual destructor More...
 

Detailed Description

BlackBoard shared memory lister.

Lister that can be used to print infos about BlackBoard shared memory segments.

Author
Tim Niemueller

Definition at line 33 of file lister.h.

Constructor & Destructor Documentation

◆ BlackBoardSharedMemoryLister()

fawkes::BlackBoardSharedMemoryLister::BlackBoardSharedMemoryLister ( )

Constructor.

Definition at line 42 of file lister.cpp.

◆ ~BlackBoardSharedMemoryLister()

fawkes::BlackBoardSharedMemoryLister::~BlackBoardSharedMemoryLister ( )
virtual

Destructor.

Definition at line 49 of file lister.cpp.

Member Function Documentation

◆ print_footer()

void fawkes::BlackBoardSharedMemoryLister::print_footer ( )
virtual

Print footer of the table.

This should fit on the terminal and thus have a width of at most 79 columns.

Implements fawkes::SharedMemoryLister.

Definition at line 77 of file lister.cpp.

◆ print_header()

void fawkes::BlackBoardSharedMemoryLister::print_header ( )
virtual

Print header of the table.

This should fit on the terminal and thus have a width of at most 79 columns.

Implements fawkes::SharedMemoryLister.

Definition at line 59 of file lister.cpp.

◆ print_info()

void fawkes::BlackBoardSharedMemoryLister::print_info ( const SharedMemoryHeader header,
int  shm_id,
int  semaphore,
unsigned int  mem_size,
const void *  memptr 
)
virtual

Print info about segment.

This method is called for every matching shared memory segment. You should print a line of information (maybe more than one line if needed) about the segment.

Parameters
headerThe data-specific header
shm_idThe id of the shared memory segment
semaphoresemaphore assigned to the shared memory segment
mem_sizethe total memory size
memptrpointer to the data segment.

Implements fawkes::SharedMemoryLister.

Definition at line 116 of file lister.cpp.

◆ print_no_orphaned_segments()

void fawkes::BlackBoardSharedMemoryLister::print_no_orphaned_segments ( )
virtual

Print this if no matching orphaned segment was found.

Called by SharedMemory::erase_orphaned() if no matching segment could be found.

Implements fawkes::SharedMemoryLister.

Definition at line 98 of file lister.cpp.

◆ print_no_segments()

void fawkes::BlackBoardSharedMemoryLister::print_no_segments ( )
virtual

Print this if no matching segment was found.

Called by SharedMemory if no matching segment could be found.

Implements fawkes::SharedMemoryLister.

Definition at line 87 of file lister.cpp.


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