An API component which can be used to create a connection to a queue manager. More...
#include <iqueue_manager_api.h>
Public Member Functions | |
virtual IQueue_manager_connection * | connect (const char *address, const char *user_name, const char *password, Sint32 *errors=0)=0 |
Creates a connection to a queue manager server. 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< 0x2bdfce73, ... > | |
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< 0x2bdfce73, ... > | |
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... | |
An API component which can be used to create a connection to a queue manager.
|
pure virtual |
Creates a connection to a queue manager server.
address | The WebSocket URL of the queue manager. If the queue manager server listens on host "somehost" and port 80, then the client will connect using the URL "ws://somehost:80" . If the connection is encrypted using the SSL protocol, then the prefix "wss" needs to be used instead of "ws" . Note that the port must be specified. The standard port for WebSockets is 80 and 443 for secure WebSockets. Queue manager instances running on the VCA use SSL and run on port 443. The corresponding URL of the Iray Bridge server to upload scenes and to create snapshots can be obtained by appending "/iray_server_bridge.ws" . | |
user_name | The user name to be used for logging into the queue manager. | |
password | The password to be used for logging into the queue 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:
|
NULL
in case of failures.