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

Inheritance diagram for mi::neuraylib::ICluster_manager_configuration:

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...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x6ac7506d, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x6ac7506d, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. More...

Detailed Description

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

Member Function Documentation

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.
[out]	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.