fml::ScopedCleanupClosure Class Reference

Wraps a closure that is invoked in the destructor unless released by the caller. More...

#include <closure.h>

Public Member Functions
	ScopedCleanupClosure ()=default
	ScopedCleanupClosure (ScopedCleanupClosure &&other)
ScopedCleanupClosure &	operator= (ScopedCleanupClosure &&other)
	ScopedCleanupClosure (const fml::closure &closure)
	~ScopedCleanupClosure ()
fml::closure	SetClosure (const fml::closure &closure)
fml::closure	Release ()
void	Reset ()

Detailed Description

Wraps a closure that is invoked in the destructor unless released by the caller.

This is especially useful in dealing with APIs that return a resource by accepting ownership of a sub-resource and a closure that releases that resource. When such APIs are chained, each link in the chain must check that the next member in the chain has accepted the resource. If not, it must invoke the closure eagerly. Not doing this results in a resource leak in the erroneous case. Using this wrapper, the closure can be released once the next call in the chain has successfully accepted ownership of the resource. If not, the closure gets invoked automatically at the end of the scope. This covers the cases where there are early returns as well.

Definition at line 32 of file closure.h.

Constructor & Destructor Documentation

ScopedCleanupClosure() [1/3]

fml::ScopedCleanupClosure::ScopedCleanupClosure ( )

default

ScopedCleanupClosure() [2/3]

fml::ScopedCleanupClosure::ScopedCleanupClosure ( ScopedCleanupClosure &&  other )

inline

Definition at line 36 of file closure.h.

                                                     {
    closure_ = other.Release();
  }

ScopedCleanupClosure() [3/3]

fml::ScopedCleanupClosure::ScopedCleanupClosure ( const fml::closure &  closure )

inlineexplicit

Definition at line 45 of file closure.h.

      : closure_(closure) {}

~ScopedCleanupClosure()

fml::ScopedCleanupClosure::~ScopedCleanupClosure ( )

inline

Definition at line 48 of file closure.h.

{ Reset(); }

Member Function Documentation

operator=()

ScopedCleanupClosure & fml::ScopedCleanupClosure::operator= ( ScopedCleanupClosure &&  other )

inline

Definition at line 40 of file closure.h.

                                                                {
    closure_ = other.Release();
    return *this;
  }

Release()

fml::closure fml::ScopedCleanupClosure::Release ( )

inline

Definition at line 56 of file closure.h.

                       {
    fml::closure closure = closure_;
    closure_ = nullptr;
    return closure;
  }

Reset()

void fml::ScopedCleanupClosure::Reset ( )

inline

Definition at line 62 of file closure.h.

               {
    if (closure_) {
      closure_();
      closure_ = nullptr;
    }
  }

SetClosure()

fml::closure fml::ScopedCleanupClosure::SetClosure ( const fml::closure &  closure )

inline

Definition at line 50 of file closure.h.

                                                   {
    auto old_closure = closure_;
    closure_ = closure;
    return old_closure;
  }

---

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

• fml/closure.h