VRay.VRayServer Class Reference

Main class representing the render server of V-Ray. The server listens on a specified port for render requests. More...

Inherits IDisposable.

Public Types
enum	AddHostsResult
	Result of AddHosts method

Public Member Functions
	VRayServer (ServerOptions serverOptions)
AddHostsResult	AddHosts (string hosts)
	Adds hosts to the dispatcher for distributed rendering. More...
void	Dispose ()
	Closes the V-Ray server which stops any render processes and releases all resources associated with them.
bool	RemoveHosts (string hosts)
	Removes hosts from the dispatcher for distributed rendering. More...
bool	ResetHosts (string hosts=null)
	Resets the dispatcher host list used for distributed rendering. Removes all if null is passed. More...
void	Run ()
	Runs the V-Ray server. This is a blocking call.
bool	Start ()
	Starts the V-Ray server. This is a non-blocking call. More...
void	Stop ()
	Stops the V-Ray server.

Properties
string	ActiveHosts [get]
	Gets a colon separated string of ip:port pairs for the active rendering hosts. More...
string	AllHosts [get]
	Gets a colon separated string of ip:port pairs for all active and inactive rendering hosts. More...
EventHandler< HostEventArgs >	HostConnected
	The event is sent when a new connection to the server has been established.
EventHandler< HostEventArgs >	HostDisconnected
	The event is sent when an existing connection to the server has been terminated.
string	InactiveHosts [get]
	Gets a colon separated string of ip:port pairs for the inactive rendering hosts. More...
EventHandler< MessageEventArgs >	LogMessage
	The event is sent when a new message becomes available. The message contains info specific to the current internal render event.
EventHandler	Started
	The event is sent when the V-Ray server starts and is ready to accept render requests.

Detailed Description

Main class representing the render server of V-Ray. The server listens on a specified port for render requests.

Member Function Documentation

AddHosts()

AddHostsResult VRay.VRayServer.AddHosts

(

string

hosts

)

Adds hosts to the dispatcher for distributed rendering.

Available in DR2 only

Parameters

hosts

Ip:port pairs as String delimited by ',' or ';'.

Returns

See AddHostsResult enum for details

RemoveHosts()

bool VRay.VRayServer.RemoveHosts

(

string

hosts

)

Removes hosts from the dispatcher for distributed rendering.

Available in DR2 only

Parameters

hosts

Ip:port pairs as String delimited by ',' or ';'.

Returns

True if the hosts were successfully removed.

ResetHosts()

bool VRay.VRayServer.ResetHosts

(

string

hosts = null

)

Resets the dispatcher host list used for distributed rendering. Removes all if null is passed.

Available in DR2 only

Parameters

hosts

Ip:port pairs as String delimited by ',' or ';'.

Returns

True on success, False on error.

Start()

bool VRay.VRayServer.Start

(

)

Starts the V-Ray server. This is a non-blocking call.

Returns

True if the server started successfully.

Property Documentation

ActiveHosts

string VRay.VRayServer.ActiveHosts

get

Gets a colon separated string of ip:port pairs for the active rendering hosts.

Available in DR2 only

AllHosts

string VRay.VRayServer.AllHosts

get

Gets a colon separated string of ip:port pairs for all active and inactive rendering hosts.

Available in DR2 only

InactiveHosts

string VRay.VRayServer.InactiveHosts

get

Gets a colon separated string of ip:port pairs for the inactive rendering hosts.

Available in DR2 only

---

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

• /home/jenkins/ci/cgrepo/appsdk/VRay_SDK_CSharp/VRay_SDK_CSharp/VRayRT/VRayServer.cs