The Gaudi Framework  master (cc9a61f4)
Loading...
Searching...
No Matches
IThreadPoolSvc Class Referenceabstract

Abstract interface for a service that manages a thread pool. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/IThreadPoolSvc.h>

Inheritance diagram for IThreadPoolSvc:
Collaboration diagram for IThreadPoolSvc:

Public Member Functions

 DeclareInterfaceID (IThreadPoolSvc, 1, 0)
 InterfaceID.
virtual StatusCode initPool (const int &poolSize, const int &maxParallelismExtra)=0
 Initializes the thread pool.
virtual StatusCode terminatePool ()=0
 Finalize the thread pool.
virtual int poolSize () const =0
 Size of the initialized thread pool.
virtual void initThisThread ()=0
 Do thread local initialization of current thread.
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)

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

Abstract interface for a service that manages a thread pool.

Also provides a method to retrieve a list of thread initialization tools. initialization tools.

Author
Charles Leggett
Date
2015-09-01

Definition at line 32 of file IThreadPoolSvc.h.

Member Function Documentation

◆ DeclareInterfaceID()

IThreadPoolSvc::DeclareInterfaceID ( IThreadPoolSvc ,
1 ,
0  )

◆ initPool()

virtual StatusCode IThreadPoolSvc::initPool ( const int & poolSize,
const int & maxParallelismExtra )
pure virtual

Initializes the thread pool.

◆ initThisThread()

virtual void IThreadPoolSvc::initThisThread ( )
pure virtual

Do thread local initialization of current thread.

Should only be used if it's determined that it has not already been done.

◆ poolSize()

virtual int IThreadPoolSvc::poolSize ( ) const
pure virtual

Size of the initialized thread pool.

◆ terminatePool()

virtual StatusCode IThreadPoolSvc::terminatePool ( )
pure virtual

Finalize the thread pool.


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