fawkes::BlackBoardSharedMemoryLister Class Reference

BlackBoard shared memory lister. More...

#include <blackboard/shmem/lister.h>

Inheritance diagram for fawkes::BlackBoardSharedMemoryLister:

Inheritance graph
[legend]

List of all members.


Public Member Functions

 BlackBoardSharedMemoryLister ()
 Constructor.
virtual ~BlackBoardSharedMemoryLister ()
 Destructor.
virtual void print_header ()
 Print header of the table.
virtual void print_footer ()
 Print footer of the table.
virtual void print_no_segments ()
 Print this if no matching segment was found.
virtual void print_no_orphaned_segments ()
 Print this if no matching orphaned segment was found.
virtual void print_info (const SharedMemoryHeader *header, int shm_id, int semaphore, unsigned int mem_size, const void *memptr)
 Print info about segment.

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

fawkes::BlackBoardSharedMemoryLister::BlackBoardSharedMemoryLister (  ) 

Constructor.

Definition at line 42 of file lister.cpp.

fawkes::BlackBoardSharedMemoryLister::~BlackBoardSharedMemoryLister (  )  [virtual]

Destructor.

Definition at line 49 of file lister.cpp.

Member Function Documentation

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.

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.

References fawkes::cblue(), fawkes::cdarkgray(), and fawkes::cnormal().

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:
header The data-specific header
shm_id The id of the shared memory segment
semaphore semaphore assigned to the shared memory segment
mem_size the total memory size
memptr pointer to the data segment.

Implements fawkes::SharedMemoryLister.

Definition at line 116 of file lister.cpp.

References fawkes::SharedMemory::is_destroyed(), fawkes::SharedMemory::is_swapable(), and fawkes::SharedMemory::num_attached().

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.

References fawkes::cdarkgray(), and fawkes::cnormal().

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: