VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxConfiguration::Cluster Struct Referenceabstract

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

#include <IVxConfiguration.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetNodeConfigurations (VxCollection< IVxConfiguration::Node ** > &nodeCollection) const =0
 Gets the configuration for the nodes that the cluster is composed of. More...
 
virtual VxResult::Value GetTimeConfig (IVxConfiguration::Time *&timeConfig) const =0
 Gets the time configuration for the cluster. More...
 
virtual VxResult::Value Refresh ()=0
 Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
 

Public Attributes

char coreVirtualIp [64]
 The virtual IP or hostname used for VideoXpert Core devices. More...
 
char mediaGatewayTranscast [64]
 The default communication method between data sources to Media Gateways and between Media Gateways to clients. More...
 
char mediaGatewayVirtualIp [64]
 The virtual IP or hostname used for Media Gateway devices. More...
 
char statusDescription [256]
 The current configuration status description. More...
 
int statusCode
 The current configuration status code. More...
 
VxConfigStatus::Value status
 The current configuration status of the entire cluster. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

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

Definition at line 94 of file IVxConfiguration.h.

Member Function Documentation

void VxSdk::IVxConfiguration::Cluster::Clear ( )
inlineprotected

Clears this instance.

Definition at line 150 of file IVxConfiguration.h.

150  {
151  VxZeroArray(this->coreVirtualIp);
152  VxZeroArray(this->mediaGatewayTranscast);
153  VxZeroArray(this->mediaGatewayVirtualIp);
154  VxZeroArray(this->statusDescription);
155  this->statusCode = 0;
156  this->status = VxConfigStatus::kUnknown;
157  }
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxConfiguration::Cluster::coreVirtualIp
char coreVirtualIp[64]
The virtual IP or hostname used for VideoXpert Core devices.
Definition: IVxConfiguration.h:123
VxSdk::IVxConfiguration::Cluster::status
VxConfigStatus::Value status
The current configuration status of the entire cluster.
Definition: IVxConfiguration.h:144
VxSdk::VxConfigStatus::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:225
VxSdk::IVxConfiguration::Cluster::statusCode
int statusCode
The current configuration status code.
Definition: IVxConfiguration.h:140
VxSdk::IVxConfiguration::Cluster::mediaGatewayTranscast
char mediaGatewayTranscast[64]
The default communication method between data sources to Media Gateways and between Media Gateways to...
Definition: IVxConfiguration.h:128
VxSdk::IVxConfiguration::Cluster::mediaGatewayVirtualIp
char mediaGatewayVirtualIp[64]
The virtual IP or hostname used for Media Gateway devices.
Definition: IVxConfiguration.h:132
VxSdk::IVxConfiguration::Cluster::statusDescription
char statusDescription[256]
The current configuration status description.
Definition: IVxConfiguration.h:136
virtual VxResult::Value VxSdk::IVxConfiguration::Cluster::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxConfiguration::Cluster::GetNodeConfigurations ( VxCollection< IVxConfiguration::Node ** > &  nodeCollection) const
pure virtual

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

Parameters
nodeCollectionA VxCollection of node configurations.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxConfiguration::Cluster::GetTimeConfig ( IVxConfiguration::Time *&  timeConfig) const
pure virtual

Gets the time configuration for the cluster.

Parameters
timeConfigThe time configuration.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxConfiguration::Cluster::Refresh ( )
pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns
The Result of refreshing the member values for this object.

Member Data Documentation

char VxSdk::IVxConfiguration::Cluster::coreVirtualIp[64]

The virtual IP or hostname used for VideoXpert Core devices.

Definition at line 123 of file IVxConfiguration.h.

char VxSdk::IVxConfiguration::Cluster::mediaGatewayTranscast[64]

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

Definition at line 128 of file IVxConfiguration.h.

char VxSdk::IVxConfiguration::Cluster::mediaGatewayVirtualIp[64]

The virtual IP or hostname used for Media Gateway devices.

Definition at line 132 of file IVxConfiguration.h.

VxConfigStatus::Value VxSdk::IVxConfiguration::Cluster::status

The current configuration status of the entire cluster.

Definition at line 144 of file IVxConfiguration.h.

int VxSdk::IVxConfiguration::Cluster::statusCode

The current configuration status code.

Definition at line 140 of file IVxConfiguration.h.

char VxSdk::IVxConfiguration::Cluster::statusDescription[256]

The current configuration status description.

Definition at line 136 of file IVxConfiguration.h.

The documentation for this struct was generated from the following file: