mi::neuraylib::IHost_properties Class Reference

This interface contains information about a local or remote host. More...

Inheritance diagram for mi::neuraylib::IHost_properties:

Public Member Functions
virtual const IString *	get_address () const =0
	Returns the address of the host described by this property instance. More...
virtual Size	get_amount_of_memory () const =0
	Returns the amount of RAM memory in MB. More...
virtual Size	get_cpu_count () const =0
	Returns the number of CPUs. More...
virtual Size	get_siblings_per_cpu () const =0
	Returns the number of virtual CPUs in a hyperthreaded CPU. More...
virtual Size	get_gpu_count () const =0
	Returns the number of GPUs. More...
virtual const IString *	get_property (const char *key) const =0
	Generic access to properties. More...
virtual Uint32	get_host_id () const =0
	Returns the host ID of this host. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0xac76eb08, 0x1c7e, 0x43d7, 0x9e, 0xea, 0xec, 0x8d, 0x9a, 0x10, 0x23, 0x80 >
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface >	Self
	Own type. More...
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 >	IID
	Declares the interface ID (IID) of this interface. More...
Static Public Member Functions inherited from mi::base::Interface_declare< 0xac76eb08, 0x1c7e, 0x43d7, 0x9e, 0xea, 0xec, 0x8d, 0x9a, 0x10, 0x23, 0x80 >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...

Detailed Description

This interface contains information about a local or remote host.

See Also

mi::neuraylib::IGeneral_configuration, mi::neuraylib::IHost_callback

Member Function Documentation

virtual const IString* mi::neuraylib::IHost_properties::get_address ( ) const

pure virtual

Returns the address of the host described by this property instance.

The method always returns NULL if networking support is not available.

Returns

The address, or NULL in case of failure.

virtual Size mi::neuraylib::IHost_properties::get_amount_of_memory ( ) const

pure virtual

Returns the amount of RAM memory in MB.

virtual Size mi::neuraylib::IHost_properties::get_cpu_count ( ) const

pure virtual

Returns the number of CPUs.

virtual Size mi::neuraylib::IHost_properties::get_gpu_count ( ) const

pure virtual

Returns the number of GPUs.

virtual Uint32 mi::neuraylib::IHost_properties::get_host_id ( ) const

pure virtual

Returns the host ID of this host.

virtual const IString* mi::neuraylib::IHost_properties::get_property ( const char *  key) const

pure virtual

Generic access to properties.

This method provides access to a string map of additional information. To access it, call it with the key for the desired value. The current list of supported keys is as follows:

• "admin_http_server_address"
  The admin http server address:port of the host.
• "host_name"
  The host name of the host.
• "memory_size"
  The amount of RAM memory in MB on the host.
• "cpu_count"
  The number of CPUs on the host.
• "siblings_per_cpu"
  The number of virtual CPUs in a hyperthreaded CPU on the host.
• "gpu_count"
  The number of GPUs on the host.
• "maximum_allocated_memory" (*)
  Maximum allocated memory by this process in MB.
• "currently_allocated_memory" (*)
  Currently allocated memory by this process in MB.
• "cuda_device_count"
  Number of CUDA-capable devices on the host.
• "uptime"
  The number of seconds since Iray was started.
• "rtmp_port" (*)
  The port which the last RTMP server started is listening to.

(*) These properties are only supported for the local host, not for remote hosts.

The method always returns NULL if networking support is not available.

Parameters

key	The key for the property wished for

Returns

The value of the property, or NULL in case of failure.

virtual Size mi::neuraylib::IHost_properties::get_siblings_per_cpu ( ) const

pure virtual

Returns the number of virtual CPUs in a hyperthreaded CPU.