Sirikata::InstanceMethodNotReentrant Class Reference

A utility class that lets you specify that a method isn't reentrant and validate in debug mode that you're not calling it recursively. More...

#include <InstanceMethodNotReentrant.hpp>

List of all members.

Classes
class	Token
Public Member Functions
	InstanceMethodNotReentrant ()

---

Detailed Description

A utility class that lets you specify that a method isn't reentrant and validate in debug mode that you're not calling it recursively.

It checks reentrancy per instance, i.e. it is expected that it is reentrant for different instances (e.g. you might have class A and have instance A1::foo call instance A2::foo and be fine, but A1::foo eventually hitting A1::foo again on the same stack is not ok).

This might seem simple, but in cases where you are using listeners or generic callbacks it might be hard to verify statically that you don't accidentally have recursion. This lets you just annotate a bit of code to make sure it remains true. In release mode all checks are disabled and the class uses no space.

Note that you should use one of these *per non-reentrant method*. If you have A::foo and A::bar, you need one of these for each one.

To use the class, you want a declaraction like InstanceMethodNotReentrant mFooNotRentrant; in your class and then create a token in the method, e.g. void A::foo() { InstanceMethodNotReentrant::Token not_reentrant(mFooNotRentrant); }

---

Constructor & Destructor Documentation

Sirikata::InstanceMethodNotReentrant::InstanceMethodNotReentrant

(

)

[inline]

---

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

• libcore/include/sirikata/core/util/InstanceMethodNotReentrant.hpp