VRay.ServerOptions Class Reference

Options to set up a VRayServer. More...

Inherits ICloneable.

Classes
class	CreateServerOptions

Public Types
enum	CachedAssetsLimitTypeEnum

Public Member Functions
object	Clone ()

Static Public Attributes
const int	DefaultNumberOfThreads = 0
	The default number of threads with which the V-Ray server will be started.
const int	DefaultPortNumber = 0
	The default port number where the V-Ray server will listen for render requests.

Properties
CachedAssetsLimitTypeEnum	CachedAssetsLimitType [get, set]
	What kind of asset cache limiting to apply, if any.
float	CachedAssetsLimitValue [get, set]
	Value for the cache limit (hours or GB).
bool	ChangeCurrentDirectory [get, set]
	Change the current folder to remoteScenePath, default: false.
bool	DR2AsDispatcher [get, set]
	Whether the instance will act as a Dedicated Dispatcher. More...
int	DR2ConnectTimeout [get, set]
	Initial connection timeout in seconds.
bool	DR2DisableUdp [get, set]
	Whether UDP discovery should be disabled More...
string	DR2HttpProxy [get, set]
	server:port connection parameter for http connections via proxy.
bool	DR2ListenOnIpv4 [get, set]
	Whether to listen on IPv4 local sockets More...
bool	DR2ListenOnIpv6 [get, set]
	Whether to listen on IPv6 local sockets More...
bool	DR2PipelinedUpstream [get, set]
	Whether to use pipelining. Note pipelining will be disabled internally (even if requested) if a proxy is configured or is discovered between the client and a remote server. More...
bool	DR2RunLocalRenderServer [get, set]
	(Dispatcher only) Whether the dispatcher should run a local render server More...
bool	DR2SecureConnection [get, set]
	Whether SSL / TSL should be enabled for connections from / to this dispatcher / server More...
int	DR2UpstreamChannels [get, set]
	Number of upstream connections, which the client side will use, when pipelining is not enabled.
int	DR2WorkerThreadsPerServer [get, set]
	Number of worker threads per each server instance we start.
string	IncludePaths [get, set]
	Semicolon separated list of file system paths to the folders containing scene include files.
bool	KeepSceneInMemory [get, set]
	Do not write a temporary vrscene-file, keep the scene data in memory only, default: false.
bool	NoRenderLicensePreCheck [get, set]
	Do not check if RenderNode license is available when creating the server (it's always checked when rendering is started), default: false.
int	NumThreads [get, set]
	Number of threads to use for rendering (leave at 0 for all available).
bool	OverwriteLocalCacheSettings [get, set]
	True to override any local cache settings on the render servers with the value from the client machine. Default: false.
string	PluginLibraryPath [get, set]
	Alternative path to folder containing V-Ray plugins
int	PortNumber [get, set]
	Which port to accept connections on (leave at 0 for default - 20207 (DR1) or 20209 (DR2)).
string	RemoteScenePath [get, set]
	The folder in which the received vrscene-file will be written, default is the temp folder.
bool	RunAsLiveLink [get, set]
	True to use the underlying renderer as a dr/live-link interface. Default: false.

Detailed Description

Options to set up a VRayServer.

Property Documentation

DR2AsDispatcher

bool VRay.ServerOptions.DR2AsDispatcher

getset

Whether the instance will act as a Dedicated Dispatcher.

Available in DR2 only

DR2DisableUdp

bool VRay.ServerOptions.DR2DisableUdp

getset

Whether UDP discovery should be disabled

Available in DR2 only

DR2ListenOnIpv4

bool VRay.ServerOptions.DR2ListenOnIpv4

getset

Whether to listen on IPv4 local sockets

Available in DR2 only

DR2ListenOnIpv6

bool VRay.ServerOptions.DR2ListenOnIpv6

getset

Whether to listen on IPv6 local sockets

Available in DR2 only

DR2PipelinedUpstream

bool VRay.ServerOptions.DR2PipelinedUpstream

getset

Whether to use pipelining. Note pipelining will be disabled internally (even if requested) if a proxy is configured or is discovered between the client and a remote server.

Available in DR2 only

DR2RunLocalRenderServer

bool VRay.ServerOptions.DR2RunLocalRenderServer

getset

(Dispatcher only) Whether the dispatcher should run a local render server

Available in DR2 only

DR2SecureConnection

bool VRay.ServerOptions.DR2SecureConnection

getset

Whether SSL / TSL should be enabled for connections from / to this dispatcher / server

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/ServerOptions.cs