HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_Service::ClientInfo Struct Reference

Service client array entry. More...

#include <PDG_Service.h>

Public Member Functions

 ClientInfo (const PDG_Service *service, const UT_StringHolder &server_address, int server_port, int client_num)
 Constructs a new client info instance. More...
 
 ClientInfo (const UT_StringHolder &client_name)
 
UT_StringHolder commandString () const
 
bool spawnProcess ()
 

Public Attributes

UT_StringArray myCommandArgs
 The array of command line args for the client. More...
 
UT_StringHolder myName
 The name of the service client. More...
 
UT_StringHolder myLogPath
 The log path for client output. More...
 
UT_StringHolder myAddress
 The connection address. More...
 
exint myPort
 The connection port. More...
 
exint myId
 The process or job id for the client. More...
 
exint myTotalCooks
 The total number of tasks the service has cooked. More...
 
int64 myMemoryUsage
 
PDG_WorkItemID myLock
 
bool myIsConnected
 Set to true once the client has connected. More...
 
bool myIsActive
 Set to true if the client is active for a job. More...
 

Detailed Description

Service client array entry.

Definition at line 67 of file PDG_Service.h.

Constructor & Destructor Documentation

PDG_Service::ClientInfo::ClientInfo ( const PDG_Service service,
const UT_StringHolder server_address,
int  server_port,
int  client_num 
)

Constructs a new client info instance.

PDG_Service::ClientInfo::ClientInfo ( const UT_StringHolder client_name)

Constructs an incomplete client instance – this is used for compatbility with older version of Houdini that did not explicitly track client info

Member Function Documentation

UT_StringHolder PDG_Service::ClientInfo::commandString ( ) const

Returns the command for the client as a string, but combining the command arguments

bool PDG_Service::ClientInfo::spawnProcess ( )

Spawns the client as a child process, and returns true on success

Member Data Documentation

UT_StringHolder PDG_Service::ClientInfo::myAddress

The connection address.

Definition at line 100 of file PDG_Service.h.

UT_StringArray PDG_Service::ClientInfo::myCommandArgs

The array of command line args for the client.

Definition at line 91 of file PDG_Service.h.

exint PDG_Service::ClientInfo::myId

The process or job id for the client.

Definition at line 107 of file PDG_Service.h.

bool PDG_Service::ClientInfo::myIsActive

Set to true if the client is active for a job.

Definition at line 124 of file PDG_Service.h.

bool PDG_Service::ClientInfo::myIsConnected

Set to true once the client has connected.

Definition at line 121 of file PDG_Service.h.

PDG_WorkItemID PDG_Service::ClientInfo::myLock

The ID of the work item that has locked the service client, if any

Definition at line 118 of file PDG_Service.h.

UT_StringHolder PDG_Service::ClientInfo::myLogPath

The log path for client output.

Definition at line 97 of file PDG_Service.h.

int64 PDG_Service::ClientInfo::myMemoryUsage

The amount of memory in use by the process, as recorded by the last task that cooked using the client

Definition at line 114 of file PDG_Service.h.

UT_StringHolder PDG_Service::ClientInfo::myName

The name of the service client.

Definition at line 94 of file PDG_Service.h.

exint PDG_Service::ClientInfo::myPort

The connection port.

Definition at line 104 of file PDG_Service.h.

exint PDG_Service::ClientInfo::myTotalCooks

The total number of tasks the service has cooked.

Definition at line 110 of file PDG_Service.h.


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