WPILibC++  2019.3.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
wpi::DebugEpochBase Class Reference

A base class for data structure classes wishing to make iterators ("handles") pointing into themselves fail-fast. More...

#include <EpochTracker.h>

Inheritance diagram for wpi::DebugEpochBase:
wpi::DenseMapBase< DenseMap< KeyT, ValueT, KeyInfoT, BucketT >, KeyT, ValueT, KeyInfoT, BucketT > wpi::DenseMapBase< SmallDenseMap< KeyT, unsigned, InlineBuckets, KeyInfoT, BucketT >, KeyT, unsigned, KeyInfoT, BucketT > wpi::DenseMapBase< SmallDenseMap< KeyT, ValueT, InlineBuckets, KeyInfoT, BucketT >, KeyT, ValueT, KeyInfoT, BucketT > wpi::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT > wpi::DenseMap< KeyT, ValueT, KeyInfoT, BucketT > wpi::SmallDenseMap< KeyT, unsigned, N > wpi::SmallDenseMap< KeyT, ValueT, InlineBuckets, KeyInfoT, BucketT >

Classes

class  HandleBase
 A base class for iterator classes ("handles") that wish to poll for iterator invalidating modifications in the underlying data structure. More...
 

Public Member Functions

void incrementEpoch ()
 Calling incrementEpoch invalidates all handles pointing into the calling instance. More...
 
 ~DebugEpochBase ()
 The destructor calls incrementEpoch to make use-after-free bugs more likely to crash deterministically. More...
 

Detailed Description

A base class for data structure classes wishing to make iterators ("handles") pointing into themselves fail-fast.

When building without asserts, this class is empty and does nothing.

DebugEpochBase does not by itself track handles pointing into itself. The expectation is that routines touching the handles will poll on isHandleInSync at appropriate points to assert that the handle they're using is still valid.

Constructor & Destructor Documentation

wpi::DebugEpochBase::~DebugEpochBase ( )
inline

The destructor calls incrementEpoch to make use-after-free bugs more likely to crash deterministically.

Member Function Documentation

void wpi::DebugEpochBase::incrementEpoch ( )
inline

Calling incrementEpoch invalidates all handles pointing into the calling instance.


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