#include <PDG_ServiceClient.h>

Public Member Functions
	PDG_ServiceClient (const PDG_Service *service, const UT_StringHolder &server_address, int server_port, int client_num)
	Constructs a new client info instance. More...

	PDG_ServiceClient (const UT_StringHolder &client_name, int client_num)

UT_StringHolder	commandString () const

const UT_StringArray &	commandArgs () const
	Returns the current command line args for the service client. More...

const UT_StringHolder &	name () const
	Returns the current name of the service client. More...

const UT_StringHolder &	logPath () const
	Returns the log path for the client. More...

const UT_StringHolder &	address () const
	Returns the MQ connection address. More...

exint	clientNumber () const
	Returns the client number. More...

exint	port () const
	Returns the MQ connection port. More...

exint	id () const
	Returns the process or job ID. More...

void	setId (exint id)
	Sets the current job ID. More...

exint	totalCooks () const
	Returns the total number of jobs the client has cooked. More...

exint	memoryUsage () const
	Returns the current memory usage. More...

PDG_WorkItemID	lock () const
	Gets the current client work item lock, or -1 if one isn't set. More...

bool	isConnected () const
	Returns whether or not the client is connected to the MQ. More...

bool	isActive () const
	Returns whether or not the client is active. More...

Friends
class	PDG_Service

Detailed Description

Definition at line 27 of file PDG_ServiceClient.h.

Constructor & Destructor Documentation

PDG_ServiceClient::PDG_ServiceClient	(	const PDG_Service *	service,
		const UT_StringHolder &	server_address,
		int	server_port,
		int	client_num
	)

Constructs a new client info instance.

PDG_ServiceClient::PDG_ServiceClient	(	const UT_StringHolder &	client_name,
		int	client_num
	)

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

const UT_StringHolder& PDG_ServiceClient::address ( ) const

inline

Returns the MQ connection address.

Definition at line 66 of file PDG_ServiceClient.h.

exint PDG_ServiceClient::clientNumber ( ) const

inline

Returns the client number.

Definition at line 71 of file PDG_ServiceClient.h.

const UT_StringArray& PDG_ServiceClient::commandArgs ( ) const

inline

Returns the current command line args for the service client.

Definition at line 51 of file PDG_ServiceClient.h.

UT_StringHolder PDG_ServiceClient::commandString ( ) const

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

exint PDG_ServiceClient::id ( ) const

inline

Returns the process or job ID.

Definition at line 79 of file PDG_ServiceClient.h.

bool PDG_ServiceClient::isActive ( ) const

inline

Returns whether or not the client is active.

Definition at line 104 of file PDG_ServiceClient.h.

bool PDG_ServiceClient::isConnected ( ) const

inline

Returns whether or not the client is connected to the MQ.

Definition at line 100 of file PDG_ServiceClient.h.

PDG_WorkItemID PDG_ServiceClient::lock ( ) const

inline

Gets the current client work item lock, or -1 if one isn't set.

Definition at line 96 of file PDG_ServiceClient.h.

const UT_StringHolder& PDG_ServiceClient::logPath ( ) const

inline

Returns the log path for the client.

Definition at line 61 of file PDG_ServiceClient.h.

exint PDG_ServiceClient::memoryUsage ( ) const

inline

Returns the current memory usage.

Definition at line 91 of file PDG_ServiceClient.h.

const UT_StringHolder& PDG_ServiceClient::name ( void ) const

inline

Returns the current name of the service client.

Definition at line 56 of file PDG_ServiceClient.h.

exint PDG_ServiceClient::port ( ) const

inline

Returns the MQ connection port.

Definition at line 75 of file PDG_ServiceClient.h.

void PDG_ServiceClient::setId ( exint id )

inline

Sets the current job ID.

Definition at line 83 of file PDG_ServiceClient.h.

exint PDG_ServiceClient::totalCooks ( ) const

inline

Returns the total number of jobs the client has cooked.

Definition at line 87 of file PDG_ServiceClient.h.

Friends And Related Function Documentation

friend class PDG_Service

friend

Definition at line 108 of file PDG_ServiceClient.h.

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

PDG/PDG_ServiceClient.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation