The Gaudi Framework  master (d4ee5f7d)
Loading...
Searching...
No Matches
Gaudi::Concurrency::ConcurrencyManager Class Reference

Interface implemented by components that are allowed to set the concurrency flags of the running job. More...

#include <GaudiKernel/ConcurrencyFlags.h>

Inheritance diagram for Gaudi::Concurrency::ConcurrencyManager:
Collaboration diagram for Gaudi::Concurrency::ConcurrencyManager:

Public Member Functions

 DeclareInterfaceID (ConcurrencyManager, 1, 0)
 InterfaceID.
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET * cast ()
template<Gaudi::IsInterface TARGET>
TARGET const * cast () const
template<typename TARGET>
TARGET * cast ()
template<typename TARGET>
TARGET const * cast () const
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long addRef () const =0
 Increment the reference count of Interface instance.
virtual unsigned long release () const =0
 Release Interface instance.
virtual unsigned long refCount () const =0
 Current reference count.
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
virtual ~IInterface ()=default
 Virtual destructor.
virtual void const * i_cast (const InterfaceID &) const =0
void * i_cast (const InterfaceID &iid)

Static Protected Member Functions

static void setNumThreads (const std::size_t &nT)
 Set the number of worker threads (for MT).
static void setNumConcEvents (const std::size_t &nE)
 Set the number of concurrent events (for MT).
static void setNumProcs (const std::size_t &nP)
 Set the number of forked child processes (for MP).

Additional Inherited Members

Public Types inherited from IInterface
enum class  Status : StatusCode::code_t {
  FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,
  LAST_ERROR
}
 Return status. More...
using iid = Gaudi::InterfaceId<IInterface, 0, 0>
 Interface ID.
using ext_iids = Gaudi::interface_list<iid>
 Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long decRef () const =0
 Decrement reference count and return the new reference count.

Detailed Description

Interface implemented by components that are allowed to set the concurrency flags of the running job.

It is a friend of ConcurrencyFlags and exposes its setters as protected methods, so that only classes deriving from it can modify the number of worker threads, concurrent events or child processes.

Definition at line 83 of file ConcurrencyFlags.h.

Member Function Documentation

◆ DeclareInterfaceID()

Gaudi::Concurrency::ConcurrencyManager::DeclareInterfaceID ( ConcurrencyManager ,
1 ,
0  )

◆ setNumConcEvents()

void Gaudi::Concurrency::ConcurrencyManager::setNumConcEvents ( const std::size_t & nE)
inlinestaticprotected

Set the number of concurrent events (for MT).

Definition at line 93 of file ConcurrencyFlags.h.

static GAUDI_API void setNumConcEvents(const std::size_t &nE)

◆ setNumProcs()

void Gaudi::Concurrency::ConcurrencyManager::setNumProcs ( const std::size_t & nP)
inlinestaticprotected

Set the number of forked child processes (for MP).

Definition at line 96 of file ConcurrencyFlags.h.

static GAUDI_API void setNumProcs(const std::size_t &nP)

◆ setNumThreads()

void Gaudi::Concurrency::ConcurrencyManager::setNumThreads ( const std::size_t & nT)
inlinestaticprotected

Set the number of worker threads (for MT).

Definition at line 90 of file ConcurrencyFlags.h.

static GAUDI_API void setNumThreads(const std::size_t &nT)

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