The Cluster class represents cluster configuration attributes. This representation shall be identical within a cluster, regardless of the node it was retrieved from. More...

#include <Configuration.h>

Public Member Functions
	Cluster (VxSdk::IVxConfiguration::Cluster *vxConfigCluster)
	Constructor. More...

virtual	~Cluster ()
	Destructor. More...

	!Cluster ()
	Finaliser. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::Collections::Generic::List< Node^ >^	_GetNodeConfigurations ()

Time^	_GetTimeConfig ()

Package Attributes
VxSdk::IVxConfiguration::Cluster *	_configCluster

Properties
System::Collections::Generic::List< Node^ >^	NodeConfigurations `[get]`
	Gets the configuration for the nodes that the cluster is composed of. More...

Time^	TimeConfig `[get]`
	Gets the time configuration for the cluster. More...

System::String^	CoreVirtualIp `[get]`
	Gets virtual IP or hostname used for VideoXpert Core devices. More...

System::String^	MediaGatewayTranscast `[get]`
	Gets the default communication method between data sources to Media Gateways and between Media Gateways to clients. More...

System::String^	MediaGatewayVirtualIp `[get]`
	Gets the virtual IP or hostname used for Media Gateway devices. More...

System::String^	StatusDescription `[get]`
	Gets the current configuration status description. More...

int	StatusCode `[get]`
	Gets the current configuration status code. More...

ConfigStatus	Status `[get]`
	Gets the current configuration status of the entire cluster. More...

Detailed Description

The Cluster class represents cluster configuration attributes. This representation shall be identical within a cluster, regardless of the node it was retrieved from.

Definition at line 153 of file Configuration.h.

Constructor & Destructor Documentation

CPPCli::Configuration::Cluster::Cluster ( VxSdk::IVxConfiguration::Cluster * vxConfigCluster )

Constructor.

Parameters

vxConfigCluster The vx cluster configuration.

Definition at line 34 of file Configuration.cpp.

                                                                                  {
     _configCluster = vxConfigCluster;
 }

virtual CPPCli::Configuration::Cluster::~Cluster ( )

inlinevirtual

Destructor.

Definition at line 165 of file Configuration.h.

                                {
                 this->!Cluster();
             }

CPPCli::Configuration::Cluster::!Cluster ( )

Finaliser.

Definition at line 38 of file Configuration.cpp.

                                      {
     _configCluster->Delete();
     _configCluster = nullptr;
 }

Member Function Documentation

System::Collections::Generic::List< CPPCli::Configuration::Node^ > CPPCli::Configuration::Cluster::_GetNodeConfigurations ( )

package

Definition at line 47 of file Configuration.cpp.

                                                                                                            {
     // Create a list of managed node objects
     List<Node^>^ mlist = gcnew List<Node^>();
     // Create a collection of unmanaged node objects
     VxSdk::VxCollection<VxSdk::IVxConfiguration::Node**> nodes;
 
     // Make the GetNodeConfigurations call, which will return with the total count of nodes, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _configCluster->GetNodeConfigurations(nodes);
     // Unless there are no nodes on the system, this should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // An array of pointers is allocated using the size returned by the previous GetNodeConfigurations call
         nodes.collection = new VxSdk::IVxConfiguration::Node*[nodes.collectionSize];
         result = _configCluster->GetNodeConfigurations(nodes);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < nodes.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Configuration::Node(nodes.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] nodes.collection;
     }
     return mlist;
 }

CPPCli::Configuration::Time CPPCli::Configuration::Cluster::_GetTimeConfig ( )

package

Definition at line 71 of file Configuration.cpp.

                                                                     {
     // Get the time config for the cluster
     VxSdk::IVxConfiguration::Time* time = nullptr;
     VxSdk::VxResult::Value result = _configCluster->GetTimeConfig(time);
 
     // Return the time config if GetTimeConfig was successful
     if (result == VxSdk::VxResult::kOK)
         return gcnew CPPCli::Configuration::Time(time);
 
     return nullptr;
 }

CPPCli::Results::Value CPPCli::Configuration::Cluster::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 43 of file Configuration.cpp.

                                                        {
     return (CPPCli::Results::Value)_configCluster->Refresh();
 }

Member Data Documentation

VxSdk::IVxConfiguration::Cluster* CPPCli::Configuration::Cluster::_configCluster

package

Definition at line 254 of file Configuration.h.

Property Documentation

System:: String^ CPPCli::Configuration::Cluster::CoreVirtualIp

get

Gets virtual IP or hostname used for VideoXpert Core devices.

The VxCore virtual IP.

Definition at line 202 of file Configuration.h.

System:: String^ CPPCli::Configuration::Cluster::MediaGatewayTranscast

get

Gets the default communication method between data sources to Media Gateways and between Media Gateways to clients.

The communication method.

Definition at line 212 of file Configuration.h.

System:: String^ CPPCli::Configuration::Cluster::MediaGatewayVirtualIp

get

Gets the virtual IP or hostname used for Media Gateway devices.

The Media Gateway virtual IP.

Definition at line 221 of file Configuration.h.

System:: Collections:: Generic:: List< Node^>^ CPPCli::Configuration::Cluster::NodeConfigurations

get

Gets the configuration for the nodes that the cluster is composed of.

A List of node configurations.

Definition at line 184 of file Configuration.h.

ConfigStatus CPPCli::Configuration::Cluster::Status

get

Gets the current configuration status of the entire cluster.

The configuration status.

Definition at line 248 of file Configuration.h.

int CPPCli::Configuration::Cluster::StatusCode

get

Gets the current configuration status code.

The status code.

Definition at line 239 of file Configuration.h.

System:: String^ CPPCli::Configuration::Cluster::StatusDescription

get

Gets the current configuration status description.

The status description.

Definition at line 230 of file Configuration.h.

Time^ CPPCli::Configuration::Cluster::TimeConfig

get

Gets the time configuration for the cluster.

The time configuration.

Definition at line 193 of file Configuration.h.

The documentation for this class was generated from the following files:

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/Configuration.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/Configuration.cpp

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation