HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_ServiceManager Class Reference

#include <PDG_ServiceManager.h>

+ Inheritance diagram for PDG_ServiceManager:

Public Member Functions

 ~PDG_ServiceManager () override
 
PDG_EventEmitter::FiltersupportedEventTypes () const override
 Returns the list of supported event types for this emitter. More...
 
PDG_ServicegetService (const UT_StringHolder &name)
 
PDG_ServiceregisterService (UT_WorkBuffer &errors, const PDG_ServiceOptions &options, const UT_StringHolder &type_name, const UT_StringHolder &service_name, PDG_ServiceOwner owner)
 
void deregisterService (const UT_StringHolder &name)
 
PDG_ServiceStartResult startService (UT_WorkBuffer &errors, const UT_StringHolder &name, bool background=false)
 
bool resetClient (UT_WorkBuffer &errors, const UT_StringHolder &service_name, const UT_StringHolder &client_name=UT_StringHolder::theEmptyString)
 
bool restartClient (UT_WorkBuffer &errors, const UT_StringHolder &service_name, const UT_StringHolder &client_name=UT_StringHolder::theEmptyString)
 
bool stopClient (UT_WorkBuffer &errors, const UT_StringHolder &service_name, const UT_StringHolder &client_name=UT_StringHolder::theEmptyString)
 
bool stopService (UT_WorkBuffer &errors, const UT_StringHolder &name, bool ignore_stopped)
 
bool stopServicesForScheduler (const UT_StringHolder &scheduler_name, const UT_StringHolder &context_name, bool stop_internal_services)
 
bool unlockService (PDG_WorkItemID lock_id, PDG_ServiceResetType reset_type, UT_WorkBuffer &errors)
 
UT_StringArray registeredServiceNames () const
 
UT_StringArray registeredServiceNames (PDG_ServiceOwner owner_filter) const
 
bool hasServiceSupport (PDG_SchedulerType *scheduler_type)
 
void stopAllServices ()
 
void removeAllServiceInstances ()
 
- Public Member Functions inherited from PDG_EventEmitter
 PDG_EventEmitter (PDG_EventQueue *eventQueue, bool block_destruction)
 
virtual ~PDG_EventEmitter ()
 
int64 getMemoryUsage (bool inclusive) const
 Returns memory usage for this event emitter instance. More...
 
bool addEventHandler (PDG_EventHandler *handler)
 Adds an event handlers that listens for all types of events. More...
 
bool addEventHandler (PDG_EventHandler *handler, PDG_EventType event)
 Adds an event handlers that listens for a specific event. More...
 
bool addEventHandler (PDG_EventHandler *handler, const Filter &filter)
 
void removeEventHandler (PDG_EventHandler *handler)
 Removes an event handler from this emitter. More...
 
void removeAllEventHandlers (bool user_handler_only=false)
 
void emitEvent (const PDG_Event &evt) const
 Emit an event to all handlers. More...
 
void eventHandlers (HandlerArray &handlers) const
 
void setEventQueue (PDG_EventQueue *eventQueue)
 
void eventQueueDestroyed ()
 

Static Public Member Functions

static PDG_ServiceManagerget ()
 
static void saveRegisteredServices ()
 
static void loadSavedServices ()
 
static void createDefaultServices ()
 

Static Public Attributes

static const int theServiceSerializationVersion
 The serialization version of the service.json file format. More...
 
static const UT_StringHolder theServiceRegistryFile
 
static const UT_StringHolder theServiceSessionAddress
 The connection address for session services. More...
 

Additional Inherited Members

- Public Types inherited from PDG_EventEmitter
using Filter = UT_ValArray< PDG_EventType >
 
using FilterMap = UT_ArrayMap< PDG_EventHandler *, Filter >
 
using HandlerSet = UT_ArraySet< PDG_EventHandler * >
 
using HandlerArray = UT_Array< PDG_EventHandler * >
 
- Protected Attributes inherited from PDG_EventEmitter
HandlerSet myHandlers
 
FilterMap myFilters
 
UT_TBBSpinLock myHandlersLock
 
bool myBeingDestroyedFlag = false
 

Detailed Description

Definition at line 26 of file PDG_ServiceManager.h.

Constructor & Destructor Documentation

PDG_ServiceManager::~PDG_ServiceManager ( )
override

Member Function Documentation

static void PDG_ServiceManager::createDefaultServices ( )
static
void PDG_ServiceManager::deregisterService ( const UT_StringHolder name)
static PDG_ServiceManager& PDG_ServiceManager::get ( )
static
PDG_Service* PDG_ServiceManager::getService ( const UT_StringHolder name)
bool PDG_ServiceManager::hasServiceSupport ( PDG_SchedulerType scheduler_type)
static void PDG_ServiceManager::loadSavedServices ( )
static
UT_StringArray PDG_ServiceManager::registeredServiceNames ( ) const
UT_StringArray PDG_ServiceManager::registeredServiceNames ( PDG_ServiceOwner  owner_filter) const
PDG_Service* PDG_ServiceManager::registerService ( UT_WorkBuffer errors,
const PDG_ServiceOptions options,
const UT_StringHolder type_name,
const UT_StringHolder service_name,
PDG_ServiceOwner  owner 
)
void PDG_ServiceManager::removeAllServiceInstances ( )
bool PDG_ServiceManager::resetClient ( UT_WorkBuffer errors,
const UT_StringHolder service_name,
const UT_StringHolder client_name = UT_StringHolder::theEmptyString 
)
bool PDG_ServiceManager::restartClient ( UT_WorkBuffer errors,
const UT_StringHolder service_name,
const UT_StringHolder client_name = UT_StringHolder::theEmptyString 
)
static void PDG_ServiceManager::saveRegisteredServices ( )
static
PDG_ServiceStartResult PDG_ServiceManager::startService ( UT_WorkBuffer errors,
const UT_StringHolder name,
bool  background = false 
)
void PDG_ServiceManager::stopAllServices ( )
bool PDG_ServiceManager::stopClient ( UT_WorkBuffer errors,
const UT_StringHolder service_name,
const UT_StringHolder client_name = UT_StringHolder::theEmptyString 
)
bool PDG_ServiceManager::stopService ( UT_WorkBuffer errors,
const UT_StringHolder name,
bool  ignore_stopped 
)
bool PDG_ServiceManager::stopServicesForScheduler ( const UT_StringHolder scheduler_name,
const UT_StringHolder context_name,
bool  stop_internal_services 
)
PDG_EventEmitter::Filter& PDG_ServiceManager::supportedEventTypes ( ) const
overridevirtual

Returns the list of supported event types for this emitter.

Implements PDG_EventEmitter.

bool PDG_ServiceManager::unlockService ( PDG_WorkItemID  lock_id,
PDG_ServiceResetType  reset_type,
UT_WorkBuffer errors 
)

Member Data Documentation

const UT_StringHolder PDG_ServiceManager::theServiceRegistryFile
static

The name of the .json file that contains services defintions, stored in the houdini prefs directory

Definition at line 34 of file PDG_ServiceManager.h.

const int PDG_ServiceManager::theServiceSerializationVersion
static

The serialization version of the service.json file format.

Definition at line 30 of file PDG_ServiceManager.h.

const UT_StringHolder PDG_ServiceManager::theServiceSessionAddress
static

The connection address for session services.

Definition at line 37 of file PDG_ServiceManager.h.


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