__gnu_debug::_Safe_sequence_base Class Reference

Base class that supports tracking of iterators that reference a sequence. More...

#include <safe_base.h>

Inheritance diagram for __gnu_debug::_Safe_sequence_base:

Collaboration diagram for __gnu_debug::_Safe_sequence_base:

Public Member Functions
void	_M_attach (_Safe_iterator_base *__it, bool __constant)
	Attach an iterator to this sequence. More...
void	_M_attach_single (_Safe_iterator_base *__it, bool __constant) throw ()
	Likewise but not thread safe. More...
void	_M_detach (_Safe_iterator_base *__it)
	Detach an iterator from this sequence. More...
void	_M_detach_single (_Safe_iterator_base *__it) throw ()
	Likewise but not thread safe. More...
void	_M_invalidate_all () const
	Invalidates all iterators. More...

Public Attributes
_Safe_iterator_base *	_M_const_iterators
	The list of constant iterators that reference this container. More...
_Safe_iterator_base *	_M_iterators
	The list of mutable iterators that reference this container. More...
unsigned int	_M_version
	The container version number. This number may never be 0. More...

Protected Member Functions
	_Safe_sequence_base () _GLIBCXX_NOEXCEPT
	~_Safe_sequence_base ()
	Notify all iterators that reference this sequence that the sequence is being destroyed. More...
void	_M_detach_all ()
	Detach all iterators, leaving them singular. More...
void	_M_detach_singular ()
	Detach all singular iterators. More...
__gnu_cxx::__mutex &	_M_get_mutex () throw ()
	For use in _Safe_sequence. More...
void	_M_revalidate_singular ()
	Revalidates all attached singular iterators. More...
void	_M_swap (_Safe_sequence_base &__x) _GLIBCXX_USE_NOEXCEPT
	Swap this sequence with the given sequence. More...

Detailed Description

Base class that supports tracking of iterators that reference a sequence.

The _Safe_sequence_base class provides basic support for tracking iterators into a sequence. Sequences that track iterators must derived from _Safe_sequence_base publicly, so that safe iterators (which inherit _Safe_iterator_base) can attach to them. This class contains two linked lists of iterators, one for constant iterators and one for mutable iterators, and a version number that allows very fast invalidation of all iterators that reference the container.

This class must ensure that no operation on it may throw an exception, otherwise safe sequences may fail to provide the exception-safety guarantees required by the C++ standard.

Constructor & Destructor Documentation

__gnu_debug::_Safe_sequence_base::_Safe_sequence_base ( )

inlineprotected

__gnu_debug::_Safe_sequence_base::~_Safe_sequence_base ( )

inlineprotected

Notify all iterators that reference this sequence that the sequence is being destroyed.

References _M_detach_all().

Here is the call graph for this function:

Member Function Documentation

void __gnu_debug::_Safe_sequence_base::_M_attach	(	_Safe_iterator_base *	__it,
		bool	__constant
	)

Attach an iterator to this sequence.

void __gnu_debug::_Safe_sequence_base::_M_attach_single	(	_Safe_iterator_base *	__it,
		bool	__constant
	)
throw	(
	)

Likewise but not thread safe.

void __gnu_debug::_Safe_sequence_base::_M_detach

(

_Safe_iterator_base *

__it

)

Detach an iterator from this sequence.

void __gnu_debug::_Safe_sequence_base::_M_detach_all ( )

protected

Detach all iterators, leaving them singular.

Referenced by ~_Safe_sequence_base().

Here is the caller graph for this function:

void __gnu_debug::_Safe_sequence_base::_M_detach_single	(	_Safe_iterator_base *	__it	)
throw	(
	)

Likewise but not thread safe.

void __gnu_debug::_Safe_sequence_base::_M_detach_singular ( )

protected

Detach all singular iterators.

Postcondition

for all iterators i attached to this sequence, i->_M_version == _M_version.

__gnu_cxx::__mutex& __gnu_debug::_Safe_sequence_base::_M_get_mutex ( ) throw ( )

protected

For use in _Safe_sequence.

void __gnu_debug::_Safe_sequence_base::_M_invalidate_all ( ) const

inline

Invalidates all iterators.

void __gnu_debug::_Safe_sequence_base::_M_revalidate_singular ( )

protected

Revalidates all attached singular iterators.

This method may be used to validate iterators that were invalidated before (but for some reason, such as an exception, need to become valid again).

void __gnu_debug::_Safe_sequence_base::_M_swap ( _Safe_sequence_base &  __x )

protected

Swap this sequence with the given sequence.

This operation also swaps ownership of the iterators, so that when the operation is complete all iterators that originally referenced one container now reference the other container.

Member Data Documentation

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_const_iterators

The list of constant iterators that reference this container.

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_iterators

The list of mutable iterators that reference this container.

unsigned int __gnu_debug::_Safe_sequence_base::_M_version

mutable

The container version number. This number may never be 0.

---

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

• /usr/include/c++/5/debug/safe_base.h