RootUtils::TSMethodCall Class Reference

Helper for making a thread-safe function call. More...

#include <TSMethodCall.h>

Collaboration diagram for RootUtils::TSMethodCall:

Public Member Functions
	TSMethodCall ()
	Constructor. More...
	TSMethodCall (const TSMethodCall &other)
	Copy constructor. More...
TSMethodCall &	operator= (const TSMethodCall &other)
	Assignment. More...
	~TSMethodCall ()
	Destructor. More...
void	setProto (TClass *cls, const std::string &fname, const std::string &args, ROOT::EFunctionMatchMode mode=ROOT::kExactMatch)
	Set the function that we're to call. More...
TMethodCall *	call ()
	Return a pointer to the thread-specific TMethodCall. More...

Private Attributes
TClass *	m_cls
	Class that we're calling. More...
std::string	m_fname
	Name of the function we're calling. More...
std::string	m_args
	Argument list. More...
ROOT::EFunctionMatchMode	m_mode
	Matching mode. More...
std::unique_ptr< TMethodCall >	m_meth
	Object to call the method on the payload type. More...
std::atomic< bool >	m_initialized
	Flag whether or not m_meth has been initialized. More...
std::mutex	m_mutex
	Control access to m_assign for initialization. More...
boost::thread_specific_ptr< TMethodCall >	m_tsMeth
	Objects used to call the method on the payload object. More...

Detailed Description

Helper for making a thread-safe function call.

We can't use TMethodCall directly because we have to change the object state to make a call.

Definition at line 32 of file TSMethodCall.h.

Constructor & Destructor Documentation

TSMethodCall() [1/2]

RootUtils::TSMethodCall::TSMethodCall

(

)

Constructor.

Default constructor.

Definition at line 26 of file TSMethodCall.cxx.

  : m_cls(nullptr),
    m_mode (ROOT::kExactMatch),
    m_meth (std::make_unique<TMethodCall>()),
    m_initialized(false)
{
}

TSMethodCall() [2/2]

RootUtils::TSMethodCall::TSMethodCall

(

const TSMethodCall &

other

)

Copy constructor.

Definition at line 38 of file TSMethodCall.cxx.

  : m_cls (other.m_cls),
    m_fname (other.m_fname),
    m_args (other.m_args),
    m_mode (other.m_mode),
    m_meth (std::make_unique<TMethodCall> (*other.m_meth)),
    m_initialized (false)
{
  // Don't copy m_tsMeth.
}

~TSMethodCall()

RootUtils::TSMethodCall::~TSMethodCall

(

)

Destructor.

Definition at line 72 of file TSMethodCall.cxx.

{
  // Don't try to run the TMethodCall destructor if gCling is gone.
  TInterpreter* cling ATLAS_THREAD_SAFE = gCling;
  if (!cling) {
    (void)m_meth.release();
    m_tsMeth.release();
  }
}

Member Function Documentation

call()

TMethodCall * RootUtils::TSMethodCall::call

(

)

Return a pointer to the thread-specific TMethodCall.

Returns nullptr if setProto hasn't been called or if the method was not found.

Definition at line 109 of file TSMethodCall.cxx.

{
  // Fail if this isn't a class type.
  if (m_cls == 0) return nullptr;
 
  if (!m_initialized) {
    // Not initialized ... try to do so now.  First take the lock.
    std::lock_guard<std::mutex> lock (m_mutex);
    // cppcheck-suppress identicalInnerCondition; false positive
    if (!m_initialized) {
      m_meth->InitWithPrototype (m_cls, m_fname.c_str(), m_args.c_str(),
                                false, m_mode);
      if (!m_meth->IsValid()) {
        ::Warning ("RootUtils::Type",
                   "Can't get method for type `%s': %s (%s).",
                   m_cls->GetName(), m_fname.c_str(), m_args.c_str());
      }
      m_initialized = true;
    }
  }
 
  if (!m_meth->IsValid()) return nullptr;
 
  if (m_tsMeth.get() == 0)
    m_tsMeth.reset (new TMethodCall (*m_meth));
 
  return m_tsMeth.get();
}

operator=()

TSMethodCall & RootUtils::TSMethodCall::operator=

(

const TSMethodCall &

other

)

Assignment.

Definition at line 53 of file TSMethodCall.cxx.

{
  if (this != &other) {
    m_cls = other.m_cls;
    m_fname = other.m_fname;
    m_args = other.m_args;
    *m_meth = *other.m_meth;
    m_mode = other.m_mode;
    m_initialized = false;
 
    // Don't copy m_tsMeth.
  }
  return *this;
}

setProto()

void RootUtils::TSMethodCall::setProto	(	TClass *	cls,
		const std::string &	fname,
		const std::string &	args,
		ROOT::EFunctionMatchMode	mode = ROOT::kExactMatch
	)

Set the function that we're to call.

Parameters

cls	The class of the object we're calling.
fname	The name of the function.
args	Its argument list.
mode	Controls whether to allow for conversions.

Definition at line 90 of file TSMethodCall.cxx.

{
  m_cls = cls;
  m_fname = fname;
  m_args = args;
  m_mode = mode;
  m_initialized = false;
}

Member Data Documentation

m_args

std::string RootUtils::TSMethodCall::m_args

private

Argument list.

Definition at line 78 of file TSMethodCall.h.

m_cls

TClass* RootUtils::TSMethodCall::m_cls

private

Class that we're calling.

Definition at line 72 of file TSMethodCall.h.

m_fname

std::string RootUtils::TSMethodCall::m_fname

private

Name of the function we're calling.

Definition at line 75 of file TSMethodCall.h.

m_initialized

std::atomic<bool> RootUtils::TSMethodCall::m_initialized

private

Flag whether or not m_meth has been initialized.

We don't want to do that before we actually need it, to prevent needless parses with root6.

Definition at line 98 of file TSMethodCall.h.

m_meth

std::unique_ptr<TMethodCall> RootUtils::TSMethodCall::m_meth

private

Object to call the method on the payload type.

This will be left invalid if the payload is not a class type. This instance is not actually used for calls — since we have to change the object state to make a call (registering the arguments), this is not thread-safe. Instead, we use the thread-specific instances accessed through m_tsMeth.

Held by pointer rather than value to work around a ROOT problem where the TMethodCall destructor will crash if gCling has already been destroyed.

Definition at line 93 of file TSMethodCall.h.

m_mode

ROOT::EFunctionMatchMode RootUtils::TSMethodCall::m_mode

private

Matching mode.

Definition at line 81 of file TSMethodCall.h.

m_mutex

std::mutex RootUtils::TSMethodCall::m_mutex

private

Control access to m_assign for initialization.

Definition at line 101 of file TSMethodCall.h.

m_tsMeth

boost::thread_specific_ptr<TMethodCall> RootUtils::TSMethodCall::m_tsMeth

private

Objects used to call the method on the payload object.

Left invalid if the payload does not have class type. Copied from m_meth the first time it's used in a particular thread.

Definition at line 107 of file TSMethodCall.h.

---

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

• TSMethodCall.h
• TSMethodCall.cxx