Represents a cluster which was reserved through the cluster manager. More...
#include <icluster_manager_configuration.h>
Public Member Functions | |
virtual const char * | get_head_node ()=0 |
Returns the name of the head node of the cluster. More... | |
virtual const char * | get_software_package_id ()=0 |
Returns the ID of software package which was started on the cluster, or nullptr if no software was started. More... | |
virtual const char * | get_bridge_protocol_version ()=0 |
Returns the Bridge protocol version of the cluster. More... | |
virtual const char * | get_authentication_token ()=0 |
Returns an authentication token which has to be provided by the Bridge client when making the connection. More... | |
virtual bool | is_compatible ()=0 |
Indicates whether server's Bridge protocol version is compatible with the client's Bridge protocol version. More... | |
virtual Size | get_number_of_cluster_nodes ()=0 |
Returns the number of nodes in the cluster. More... | |
virtual ICluster_manager_node * | get_cluster_node (Size index)=0 |
Returns a node which is part of the cluster. More... | |
virtual bool | can_be_closed ()=0 |
Indicates if the cluster can be closed by the application through this API. More... | |
virtual const char * | get_head_node_address ()=0 |
Returns the address of the head node of the cluster. More... | |
virtual ICluster_manager_node * | get_head_node_descriptor ()=0 |
Returns a descriptor of the head node of the cluster. More... | |
virtual ICluster_manager_node * | grow_cluster (Sint32 *errors)=0 |
Grows the cluster by one node. More... | |
virtual Sint32 | shrink_cluster (ICluster_manager_node *node)=0 |
Shrinks the cluster by one node. More... | |
![]() | |
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 | |
![]() | |
using | Self = Interface_declare< id1, ... > |
Own type. More... | |
using | IID = Uuid_t< id1, ... > |
Declares the interface ID (IID) of this interface. More... | |
![]() | |
using | IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> |
Declares the interface ID (IID) of this interface. More... | |
![]() | |
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 bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface. More... | |
Represents a cluster which was reserved through the cluster manager.
|
pure virtual |
Indicates if the cluster can be closed by the application through this API.
|
pure virtual |
Returns an authentication token which has to be provided by the Bridge client when making the connection.
The token was generated by the cluster manager and has been passed to the software started on the server side.
|
pure virtual |
Returns the Bridge protocol version of the cluster.
This is for display purposes only. Use is_compatible() to check whether it is compatible with the client's Bridge protocol version.
|
pure virtual |
Returns a node which is part of the cluster.
index | The index of the cluster node. |
index-th
cluster node, or nullptr
if index
is out of bounds.
|
pure virtual |
Returns the name of the head node of the cluster.
|
pure virtual |
Returns the address of the head node of the cluster.
|
pure virtual |
Returns a descriptor of the head node of the cluster.
|
pure virtual |
Returns the number of nodes in the cluster.
|
pure virtual |
Returns the ID of software package which was started on the cluster, or nullptr
if no software was started.
|
pure virtual |
Grows the cluster by one node.
[out] | errors | An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:
|
nullptr
if no node was available to be added.
|
pure virtual |
Indicates whether server's Bridge protocol version is compatible with the client's Bridge protocol version.
|
pure virtual |
Shrinks the cluster by one node.
Shrinking the cluster if there's only one node remaining is not allowed. Removing the head node of the cluster is not prevented but should be avoided when calling this. There's no built-in way after the cluster has been started to tell a head node process that is has been selected as the new head node.
node | The descriptor of the node that is to be removed from the cluster. |