PDG_ServiceOptions.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_OPTIONS_H
#define PDG_SERVICE_OPTIONS_H

#include "PDG_API.h"
#include "PDG_ServiceTypes.h"

/**
 * Configuration options for a service instance, passed to PDG_ServiceManager
 * when registering a new service
 */
struct PDG_API PDG_ServiceOptions
{
    /// Default initialization
    PDG_ServiceOptions()
        : myClientLogDir("$HOUDINI_TEMP_DIR")
        , myMQLogDir("$HOUDINI_TEMP_DIR")
        , myEnvVarNames()
        , myEnvVarValues()
        , myPoolSize(5)
        , myPort(0)
        , myMQLogLevel(1)
        , myConnectionTimeout(5000)
        , myMemoryLimit(0)
        , myClientLogType(PDG_ServiceLogType::eFile)
        , myMemoryResetType(PDG_ServiceResetType::eNone)
        , myServiceSchedulerType(PDG_ServiceSchedulerType::eInstance)
        , myAutoStart(true)
        , myIsPersistent(true)
    {
    }

    /// The directory to write client logs
    UT_StringHolder             myClientLogDir;

    /// The directory to write MQ logs
    UT_StringHolder             myMQLogDir;

    /// The names of the environment variables to be set
    UT_StringArray              myEnvVarNames;

    /// The values of the environment variables to be set
    UT_StringArray              myEnvVarValues;

    /// The extra arg values appended to the end of the services command line
    UT_StringArray              myExtraArguments;

    /// The name of the scheduler type, when the service scheduler type is
    /// First of Type
    UT_StringHolder             mySchedulerTypeName;

    /// The name of the scheduler instance, when the service scheduler type
    /// is Instance
    UT_StringHolder             mySchedulerName;

    /// The name of the scheduler instance's graph context, when the service
    /// scheduler type is Instance
    UT_StringHolder             mySchedulerContextName;

    /// The service pool size
    int                         myPoolSize;

    /// The listen port
    int                         myPort;

    /// The service MQ log level
    int                         myMQLogLevel;

    /// The connection timeout, in milliseconds
    int                         myConnectionTimeout;

    /// The memory limit before a client is reset
    exint                       myMemoryLimit;

    /// The type of logging for clients
    PDG_ServiceLogType          myClientLogType;

    /// The memory reset type
    PDG_ServiceResetType        myMemoryResetType;

    /// The service scheduler type, if the service is a scheduler-owned service
    PDG_ServiceSchedulerType    myServiceSchedulerType;
                        
    /// whether or not the service should start automatically
    bool                        myAutoStart;

    /// Whether or not the service should persist to the pdgservices
    /// JSON file on disk 
    bool                        myIsPersistent;
};

#endif