Foundry::Katana::PipeSingleton Class Reference

The PipeSingleton provides a singleton wrapper around the KatanaPipe. More...

#include <KatanaPipeSingleton.h>

List of all members.

Static Public Member Functions
static KatanaPipe *	Instance (const std::string &hostName, unsigned int portNumber, const std::string &katanaPath=std::string())
static size_t	GetQueueSize ()

---

Detailed Description

The PipeSingleton provides a singleton wrapper around the KatanaPipe.

See also:

KatanaPipe

---

Member Function Documentation

static size_t Foundry::Katana::PipeSingleton::GetQueueSize

(

)

[static]

Returns the maximum number of messages that will be queued before calls to KatanaPipe::send() will begin to block. The environment variable KATANA_PIPE_MAX_QUEUE_SIZE, if set to a non-zero positive value can be used to configure this setting.

Returns:

the maximum number of messages that will be queued before calls to KatanaPipe::send() will begin to block.

static KatanaPipe* Foundry::Katana::PipeSingleton::Instance	(	const std::string &	hostName,
		unsigned int	portNumber,
		const std::string &	katanaPath = std::string()
	)		[static]

Return the KatanaPipe connected to the given hostName and portNumber

Currently, we only support the connection back to one KCD i.e. the first call to this function will define the hostName/portnumber combination that will be connected to. Subsequent calls to this function with different hostname portnumber combinations will continue to return the original pipe.

Parameters:

[in]	hostName	the hostName to be connected to as a fully qualified domain name.
[in]	portNumber	the TCP port number to the Catalog Server is listening on.
[in]	katanaPath	the path where Katana was installed to bootstrap the Display Driver host library. By default it looks for the KATANA_ROOT environment variable set by a Katana interactive or render session.

Returns:

the KatanaPipe connected to the specified end point.

---

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

• KatanaPipeSingleton.h