Shared Memory iterator. More...

#include <>>

Public Member Functions
	SharedMemoryIterator ()
	Constructor. More...

	SharedMemoryIterator (const SharedMemoryIterator &shmit)
	Copy constructor. More...

	SharedMemoryIterator (std::list< SharedMemoryRegistry::SharedMemID > ids, SharedMemoryHeader *header)
	Constructor. More...

	~SharedMemoryIterator ()
	Destructor. More...

SharedMemoryIterator &	operator++ ()
	Prefix increment. More...

SharedMemoryIterator	operator++ (int inc)
	Postfix increment operator. More...

SharedMemoryIterator &	operator+ (unsigned int i)
	Advance by i steps. More...

SharedMemoryIterator &	operator+= (unsigned int i)
	Advance by i steps. More...

bool	operator== (const SharedMemoryIterator &s) const
	Check iterators for equality. More...

bool	operator!= (const SharedMemoryIterator &s) const
	Check iterators for inequality. More...

const SharedMemoryHeader *	operator* () const
	Get SharedMemoryHeader. More...

SharedMemoryIterator &	operator= (const SharedMemoryIterator &shmit)
	Make this instance point to the same segment as shmit. More...

const char *	magic_token () const
	Get magic token. More...

int	shmid () const
	Get shared memory ID. More...

int	semaphore () const
	Get semaphore. More...

size_t	segmsize () const
	Get segment size. More...

size_t	segmnattch () const
	Get number of attached parties. More...

void *	databuf () const
	Get pointer to data buffer. More...

Detailed Description

Shared Memory iterator.

This iterator is used to iterate over shared memory segments which satisfy some criterion. Use SharedMemory::find() and SharedMemory::list() to get the iterator.

Author: Tim Niemueller

Definition at line 118 of file shm.h.

Constructor & Destructor Documentation

◆ SharedMemoryIterator() [1/3]

fawkes::SharedMemory::SharedMemoryIterator::SharedMemoryIterator ( )

Constructor.

Constructs invalid iterator.

Definition at line 1298 of file shm.cpp.

◆ SharedMemoryIterator() [2/3]

fawkes::SharedMemory::SharedMemoryIterator::SharedMemoryIterator ( const SharedMemoryIterator & shmit )

Copy constructor.

Parameters

shmit shared memory iterator to copy

Definition at line 1312 of file shm.cpp.

References fawkes::SharedMemory::attach(), and fawkes::SharedMemoryHeader::clone().

◆ SharedMemoryIterator() [3/3]

fawkes::SharedMemory::SharedMemoryIterator::SharedMemoryIterator	(	std::list< SharedMemoryRegistry::SharedMemID >	ids,
		SharedMemoryHeader *	header
	)

Constructor.

Parameters

ids	The IDs of the shared memory segments to iterate over
header	shared memory header

Definition at line 1346 of file shm.cpp.

References fawkes::SharedMemoryHeader::clone().

◆ ~SharedMemoryIterator()

fawkes::SharedMemory::SharedMemoryIterator::~SharedMemoryIterator ( )

Destructor.

Definition at line 1363 of file shm.cpp.

Member Function Documentation

◆ databuf()

void * fawkes::SharedMemory::SharedMemoryIterator::databuf ( ) const

Get pointer to data buffer.

Returns: data buffer

Definition at line 1627 of file shm.cpp.

Referenced by fawkes::SharedMemory::erase(), fawkes::SharedMemory::erase_orphaned(), and fawkes::SharedMemory::list().

◆ magic_token()

const char * fawkes::SharedMemory::SharedMemoryIterator::magic_token ( ) const

Get magic token.

Returns: magic token.

Definition at line 1578 of file shm.cpp.

◆ operator!=()

bool fawkes::SharedMemory::SharedMemoryIterator::operator!= ( const SharedMemoryIterator & s ) const

Check iterators for inequality.

Parameters

s	iterator to compare to

Returns: true if iteraters point to the same shared memory segment, false otherwise

Definition at line 1527 of file shm.cpp.

◆ operator*()

const SharedMemoryHeader * fawkes::SharedMemory::SharedMemoryIterator::operator* ( ) const

Get SharedMemoryHeader.

Returns: shared memory header

Definition at line 1536 of file shm.cpp.

◆ operator+()

SharedMemory::SharedMemoryIterator & fawkes::SharedMemory::SharedMemoryIterator::operator+ ( unsigned int i )

Advance by i steps.

Parameters

i	number of (matching) segments to advance.

Returns: reference to this after advancing

Definition at line 1491 of file shm.cpp.

◆ operator++() [1/2]

SharedMemory::SharedMemoryIterator & fawkes::SharedMemory::SharedMemoryIterator::operator++ ( )

Prefix increment.

Returns: reference to this instance

Definition at line 1428 of file shm.cpp.

References fawkes::SharedMemory::attach(), fawkes::SharedMemory::MagicTokenSize, and fawkes::SharedMemory::SharedMemory_header_t::semaphore.

◆ operator++() [2/2]

SharedMemory::SharedMemoryIterator fawkes::SharedMemory::SharedMemoryIterator::operator++ ( int inc )

Postfix increment operator.

Parameters

inc ignored

Returns: instance before advancing to the next shared memory segment

Definition at line 1479 of file shm.cpp.

◆ operator+=()

SharedMemory::SharedMemoryIterator & fawkes::SharedMemory::SharedMemoryIterator::operator+= ( unsigned int i )

Advance by i steps.

Parameters

i	number of (matching) segments to advance.

Returns: reference to this after advancing

Definition at line 1504 of file shm.cpp.

◆ operator=()

SharedMemory::SharedMemoryIterator & fawkes::SharedMemory::SharedMemoryIterator::operator= ( const SharedMemoryIterator & shmit )

Make this instance point to the same segment as shmit.

Parameters

shmit shared memory iterator

Returns: reference to this instance

Definition at line 1546 of file shm.cpp.

References fawkes::SharedMemory::attach(), and fawkes::SharedMemoryHeader::clone().

◆ operator==()

bool fawkes::SharedMemory::SharedMemoryIterator::operator== ( const SharedMemoryIterator & s ) const

Check iterators for equality.

Parameters

s	iterator to compare to

Returns: true if iterators point to the same shared memory segment, false otherwise

Definition at line 1517 of file shm.cpp.

◆ segmnattch()

size_t fawkes::SharedMemory::SharedMemoryIterator::segmnattch ( ) const

Get number of attached parties.

Returns: number of attached parties

Definition at line 1618 of file shm.cpp.

Referenced by fawkes::SharedMemory::erase_orphaned().

◆ segmsize()

size_t fawkes::SharedMemory::SharedMemoryIterator::segmsize ( ) const

Get segment size.

Returns: segment size

Definition at line 1609 of file shm.cpp.

Referenced by fawkes::SharedMemory::erase(), fawkes::SharedMemory::erase_orphaned(), and fawkes::SharedMemory::list().

◆ semaphore()

int fawkes::SharedMemory::SharedMemoryIterator::semaphore ( ) const

Get semaphore.

Returns: semaphore

Definition at line 1600 of file shm.cpp.

Referenced by fawkes::SharedMemory::erase(), fawkes::SharedMemory::erase_orphaned(), and fawkes::SharedMemory::list().

◆ shmid()

int fawkes::SharedMemory::SharedMemoryIterator::shmid ( ) const

Get shared memory ID.

Returns: shared memory ID

Definition at line 1591 of file shm.cpp.

Referenced by fawkes::SharedMemory::erase(), fawkes::SharedMemory::erase_orphaned(), and fawkes::SharedMemory::list().

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

src/libs/utils/ipc/shm.h
src/libs/utils/ipc/shm.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SharedMemoryIterator() [1/3]

◆ SharedMemoryIterator() [2/3]

◆ SharedMemoryIterator() [3/3]

◆ ~SharedMemoryIterator()

Member Function Documentation

◆ databuf()

◆ magic_token()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator=()

◆ operator==()

◆ segmnattch()

◆ segmsize()

◆ semaphore()

◆ shmid()