PDG_ServiceTypes.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_SERVICE_TYPES_H__
#define __PDG_SERVICE_TYPES_H__

#include <UT/UT_Array.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_UniquePtr.h>

class PDG_Service;
class PDG_ServiceClient;

/// Type def for registered type objects
using PDG_ServicePtr = UT_SharedPtr<PDG_Service>;

/// Type def for service clients
using PDG_ServiceClientPtr      = UT_UniquePtr<PDG_ServiceClient>;
using PDG_ServiceClientArray    = UT_Array<PDG_ServiceClientPtr>;

/// Enumeration of service block cook modes
enum class PDG_ServiceBlockCookType
{
    /// Work items will never cook using the service associated with the 
    /// parent block
    eNever,

    /// Work items will cook the parent block's service if it matches the
    /// service name for the node
    eMatch,

    /// Work items will always use the parent block's service
    eAlways,
};

/// When service clients should be reset
enum class PDG_ServiceResetWhen
{
    /// The service client is not reset
    eNone           = 0x0,

    /// The service client is reset at the start of a work item or block cook
    eBeforeCook     = 0x1,

    /// The service client is reset at the end of a work item or block cook
    eAfterCook      = 0x2,

    /// The service is reset at the beginning and end of a cook
    eBoth           = 0x3
};

/// Service client reset operation, performed each time work items acquire a
/// new client.
enum class PDG_ServiceResetType
{
    /// The service client is not reset
    eNone,

    /// The service client is sent the "reset" command
    eReset,

    /// The service client process is restarted
    eRestart
};

/// Enumeration of the different types of service owner
enum class PDG_ServiceOwner
{
    /// The service is owned by a scheduler, which means it will be tied to
    /// the lifetime of the scheduler node(s).
    eScheduler,

    /// The service is owned by the session, which means it will be stopped
    /// only if stopped by the user or Houdini is closed.
    eSession
};

/// Enumeration of the different types of scheduler services, which determines
/// how the scheduler is found
enum class PDG_ServiceSchedulerType
{
    /// The default scheduler for the graph is used to run service clients
    eDefault,

    /// The first scheduler of a specified scheduler type is used to run
    /// service clients
    eFirstType,

    /// A specific scheduler is used to run service clients
    eInstance
};

/// Enumeration of the different states that a service can be in
enum class PDG_ServiceState
{
    // The service is not running
    eStopped,

    // The service is in the process of stopping. The service will remain in
    // this state until the MQ Server and all of the service clients have
    // been issued a command to shutdown.
    eStopping,

    // The service is in the process of starting. The service will remain in
    // this state until all of the service clients have fully started up.
    eStarting,

    // The service is fully running and all clients are available.
    eRunning,

    // The service is in an unrecoverable error state
    eError
};

/// Enumeration of service log types
enum class PDG_ServiceLogType
{
    /// The service does not do any logging -- stdout is routed to
    /// /dev/null
    eNone,

    /// The service logs to stdout
    eStdout,

    /// The service logs to a file on disk
    eFile
};

/// Enumeration of possible result values from starting a service
enum class PDG_ServiceStartResult
{
    /// An error occured and the service was not started
    eError,

    /// The service was successfully started
    eSuccess,

    /// The service was already running
    eRunning,

    /// The service clients are connecting in the background
    eConnecting
};

/// Enumeration of return codes when acquiring a service client
enum class PDG_ServiceAcquireResult
{
    /// A service client was successfully acquired
    eSuccess,

    /// A service client was successfully acquired and locked
    eSuccessLocked,

    /// All service workers are already busy
    eBusy,

    /// The service worker is aleady in use by a different task
    /// with the same service lock id
    eLocked,

    /// The service lock is invalid -- should never occur in practice
    eInvalidLock,

    /// The service has no available clients, typically due to some
    /// kind of fatal error during start-up
    eNoActiveClients,
};

#endif /* __PDG_SERVICE_TYPES_H__ */