libstdc++: __gnu_debug::_Safe_unordered_container< _Container > Class Template Reference

libstdc++

__gnu_debug::_Safe_unordered_container< _Container > Class Template Reference

`#include <safe_unordered_container.h>`

Inheritance diagram for __gnu_debug::_Safe_unordered_container< _Container >:
[legend]

## Public Attributes
_Safe_iterator_base * | _M_const_iterators
_Safe_iterator_base * | _M_const_local_iterators
_Safe_iterator_base * | _M_iterators
_Safe_iterator_base * | _M_local_iterators
unsigned int | _M_version

## Protected Member Functions
void | _M_detach_all () const
void | _M_detach_singular () const
__gnu_cxx::__mutex & | _M_get_mutex () const noexcept
template<typename _VictimIt>
void | _M_invalidate (_VictimIt __victim)
template<typename _VictimIt>
void | _M_invalidate (_VictimIt __victim, const __gnu_cxx::__scoped_lock &__lock)
constexpr void | _M_invalidate_all () const
void | _M_invalidate_all ()
template<typename _Predicate>
void | _M_invalidate_all_if (_Predicate __pred)
void | _M_revalidate_singular () const
void | _M_swap (const _Safe_sequence_base &__x) const noexcept
void | _M_swap (const _Safe_unordered_container_base &__x) const noexcept

## Detailed Description

template<typename _Container>
class __gnu_debug::_Safe_unordered_container< _Container >

Base class for constructing a safe unordered container type that tracks iterators that reference it.

The class template _Safe_unordered_container simplifies the construction of safe unordered containers that track the iterators that reference the container, so that the iterators are notified of changes in the container that may affect their operation, e.g., if the container invalidates its iterators or is destructed. This class template may only be used by deriving from it and passing the name of the derived class as its template parameter via the curiously recurring template pattern. The derived class must have `iterator` and `const_iterator` types that are instantiations of class template _Safe_iterator for this container and `local_iterator` and `const_local_iterator` types that are instantiations of class template _Safe_local_iterator for this container. Iterators will then be tracked automatically.

Definition at line 129 of file safe_unordered_container.h.

## Member Function Documentation

## ◆ _M_detach_all()

void __gnu_debug::_Safe_unordered_container_base::_M_detach_all | ( |  | ) | const
| protectedinherited

Detach all iterators, leaving them singular.

Referenced by ~_Safe_unordered_container_base().

## ◆ _M_detach_singular()

void __gnu_debug::_Safe_sequence_base::_M_detach_singular | ( |  | ) | const
| protectedinherited

Detach all singular iterators.

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

## ◆ _M_get_mutex()

__gnu_cxx::__mutex & __gnu_debug::_Safe_sequence_base::_M_get_mutex | ( |  | ) | const
| protectednoexceptinherited

For use in _Safe_sequence.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

## ◆ _M_invalidate() [1/2]

template<typename _Container>
template<typename _VictimIt>

void __gnu_debug::_Safe_unordered_container< _Container >::_M_invalidate | ( | _VictimIt | __victim | ) |
| inlineprotected

Definition at line 197 of file safe_unordered_container.h.

## ◆ _M_invalidate() [2/2]

template<typename _Container>
template<typename _VictimIt>

void __gnu_debug::_Safe_unordered_container< _Container >::_M_invalidate | ( | _VictimIt | __victim,
|  | const __gnu_cxx::__scoped_lock & | __lock )
| inlineprotected

Definition at line 205 of file safe_unordered_container.h.

## ◆ _M_invalidate_all() [1/2]

void __gnu_debug::_Safe_sequence_base::_M_invalidate_all | ( |  | ) | const
| inlineconstexprprotectedinherited

Invalidates all iterators.

Definition at line 314 of file safe_base.h.

References _M_invalidate_all(), and _M_version.

Referenced by _M_invalidate_all().

## ◆ _M_invalidate_all() [2/2]

template<typename _Container>

void __gnu_debug::_Safe_unordered_container< _Container >::_M_invalidate_all | ( |  | ) |
| inlineprotected

Definition at line 170 of file safe_unordered_container.h.

## ◆ _M_invalidate_all_if()

template<typename _Container>
template<typename _Predicate>

void __gnu_debug::_Safe_unordered_container< _Container >::_M_invalidate_all_if | ( | _Predicate | __pred | ) |
| inlineprotected

Definition at line 188 of file safe_unordered_container.h.

## ◆ _M_revalidate_singular()

void __gnu_debug::_Safe_sequence_base::_M_revalidate_singular | ( |  | ) | const
| protectedinherited

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).

## ◆ _M_swap() [1/2]

void __gnu_debug::_Safe_sequence_base::_M_swap | ( | const _Safe_sequence_base & | __x | ) | const
| protectednoexceptinherited

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.

## ◆ _M_swap() [2/2]

void __gnu_debug::_Safe_unordered_container_base::_M_swap | ( | const _Safe_unordered_container_base & | __x | ) | const
| protectednoexceptinherited

Swap this container with the given container. 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

## ◆ _M_const_iterators

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_const_iterators
| mutableinherited

The list of constant iterators that reference this container.

Definition at line 227 of file safe_base.h.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

## ◆ _M_const_local_iterators

_Safe_iterator_base* __gnu_debug::_Safe_unordered_container_base::_M_const_local_iterators
| mutableinherited

The list of constant local iterators that reference this container.

Definition at line 146 of file safe_unordered_base.h.

## ◆ _M_iterators

_Safe_iterator_base* __gnu_debug::_Safe_sequence_base::_M_iterators
| mutableinherited

The list of mutable iterators that reference this container.

Definition at line 224 of file safe_base.h.

Referenced by __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if().

## ◆ _M_local_iterators

_Safe_iterator_base* __gnu_debug::_Safe_unordered_container_base::_M_local_iterators
| mutableinherited

The list of mutable local iterators that reference this container.

Definition at line 143 of file safe_unordered_base.h.

## ◆ _M_version

unsigned int __gnu_debug::_Safe_sequence_base::_M_version
| mutableinherited

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

Definition at line 230 of file safe_base.h.

Referenced by _M_invalidate_all(), __gnu_debug::_Safe_sequence< _Sequence >::_M_transfer_from_if(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_iterator< _Base_iterator, map >::operator=(), __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=(), and __gnu_debug::_Safe_local_iterator< _OtherIterator, _UContainer >::operator=().

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

- safe_unordered_container.h
- safe_unordered_container.tcc