neuray API Programmer's Manual

mi::neuraylib::ICluster_manager_configuration Class Reference

[Cluster manager]

Description

An API component which can be used to create a connection to a cluster manager.

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual ICluster_manager_connection* connect( const char* address, const char* user_name, const char* password, Sint32* errors = 0) =0
Creates a connection to a cluster manager. More...

Member Functions

virtual ICluster_manager_connection* mi::​neuraylib::​ICluster_manager_configuration::connect( const char* address, const char* user_name, const char* password, Sint32* errors = 0) [pure virtual]

Creates a connection to a cluster manager.

Parameters

address
The address of the cluster manager including the port. The address can be prefixed by "wss://" to encrypt the connection using the SSL protocol. If no prefix is given, the default prefix "ws://" is used, resulting in an unencrypted connection.
user_name
The user name to be used for logging into the cluster manager.
password
The password to be used for logging into the cluster manager.
errors
An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:
  • 0: Success.
  • -1: The connection failed. Please check the server address.
  • -2: The authentication failed. Please check user name and password.
  • -3: Streaming is disabled.
  • -5: The request timed out. Please check if the cluster manager is working properly.

Returns

The cluster manager connection, or NULL in case of failures.