Wiretap API  <small>Wiretap 2020.1</small>
WireTapServerInfo Class Reference

This class contains the properties of a Wiretap server. More...

Public Member Functions

const char * getDatabase () const
 Gets the type of database exposed by the server. More...
 
const char * getDisplayName () const
 Gets the display name of the server, which is usually just the host name. More...
 
const char * getHostname () const
 Gets the name of the host machine on which the server is running. More...
 
const char * getHostUUID () const
 
WireTapServerId getId () const
 Gets an instance of WireTapServerId which contains all the information used to define a persistent ID for the Wiretap server. More...
 
const char * getProduct () const
 Gets an identifier for the server product. More...
 
int getProductBuild () const
 Gets the build of the server product. More...
 
int getProductVersionMaint () const
 Gets the maintenance version of the Wiretap server. More...
 
int getProductVersionMajor () const
 Gets the major version of the Wiretap server. More...
 
int getProductVersionMinor () const
 Gets the minor version of the Wiretap server. More...
 
const char * getProductVersionStr () const
 Gets a string that describes the full version of the server product. More...
 
const char * getStorageId () const
 Gets the ID of the storage device that is currently connected to the server. More...
 
const char * getVendor () const
 Gets the vendor of the server product. More...
 
int getVersionMaint () const
 Gets the minor version of the protocol (for internal use). More...
 
int getVersionMajor () const
 Gets the major version of the protocol (for internal use). More...
 
int getVersionMinor () const
 Gets the minor version of the protocol (for internal use). More...
 
bool isLocal () const
 
bool isSameServer (const WireTapServerId &id) const
 
bool isSameServer (const WireTapServerInfo &info) const
 
WireTapServerInfooperator= (const WireTapServerInfo &src)
 Default assignment operator. More...
 
bool operator== (const WireTapServerInfo &other) const
 Default equal operator. More...
 
void setDatabase (const char *database)
 Sets the type of database exposed by the server. More...
 
void setProduct (const char *product)
 Sets an identifier for the server product. More...
 
void setProductBuild (int build)
 Sets the build number of the server product. More...
 
void setProductVersionMaint (int maint)
 Sets the maintenance version of the server product. More...
 
void setProductVersionMajor (int major)
 Sets the major version of the server product. More...
 
void setProductVersionMinor (int minor)
 Sets the minor version of the server product. More...
 
void setProductVersionStr (const char *version)
 Sets a string that describes the full version of the server product. More...
 
void setStorageId (const char *storageId)
 Sets the ID of the storage device connected to the server. More...
 
void setVendor (const char *vendor)
 Sets the vendor of the server product. More...
 
 WireTapServerInfo ()
 Constructs a WireTapServerInfo object. More...
 
 WireTapServerInfo (const WireTapServerInfo &info)
 Copy constructor. More...
 
 ~WireTapServerInfo ()
 Destructor. More...
 

Detailed Description

This class contains the properties of a Wiretap server.

In this context, "Wiretap server" means an instance of a particular Wiretap server implementation running on a particular host. For example: an instance of the IFFFS Wiretap Server running on a host machine named "belgium". An instance of WireTapServerInfo gives information about a Wiretap server.

Wiretap clients that need information about the Wiretap servers available to the client, can get instances of this class (WireTapServerInfo) through the WireTapServerList class, more specifically, the WireTapServerList::getNode method.

If a Wiretap client calls the set methods of this class on a local instance of the class, the information stored on the Wiretap server is not changed.

A Wiretap client that needs to access and/or modify the data exposed by the Wiretap server, should do so using an instance of WireTapServerHandle.

See also
WireTapServerHandle, WireTapServerList

Constructor & Destructor Documentation

§ WireTapServerInfo() [1/2]

WireTapServerInfo::WireTapServerInfo ( )

Constructs a WireTapServerInfo object.

§ WireTapServerInfo() [2/2]

WireTapServerInfo::WireTapServerInfo ( const WireTapServerInfo info)

Copy constructor.

Constructs a new WireTapServerInfo object duplicating the content of the original.

Parameters
infoAn input parameter. The WiretapServerInfo object that is to be copied.

§ ~WireTapServerInfo()

WireTapServerInfo::~WireTapServerInfo ( )

Destructor.

Member Function Documentation

§ getDatabase()

const char* WireTapServerInfo::getDatabase ( ) const

Gets the type of database exposed by the server.

Returns
A string that describes the type of database by the server. For example, IFFFS or Backburner.

§ getDisplayName()

const char* WireTapServerInfo::getDisplayName ( ) const

Gets the display name of the server, which is usually just the host name.

Returns
A string containing the display name of the server.

§ getHostname()

const char* WireTapServerInfo::getHostname ( ) const

Gets the name of the host machine on which the server is running.

Returns
A string that is usually the IP address of the host.
Deprecated:
Since Wiretap 2007.1. The preferred method is WireTapServerHandle::getHostName.

§ getHostUUID()

const char* WireTapServerInfo::getHostUUID ( ) const
Returns
The UUID of the host machine on which the server is running.
Note
See also WireTapServerHandle::getHostUUID.

§ getId()

WireTapServerId WireTapServerInfo::getId ( ) const

Gets an instance of WireTapServerId which contains all the information used to define a persistent ID for the Wiretap server.

Returns
A WireTapServerId object that contains the information used to define the persistent ID for the server. It may include some or all of the following information: host name or IP address, database type, and/or TCP port.

§ getProduct()

const char* WireTapServerInfo::getProduct ( ) const

Gets an identifier for the server product.

Returns
A string that identifies the server product.

§ getProductBuild()

int WireTapServerInfo::getProductBuild ( ) const

Gets the build of the server product.

Returns
An integer that is the build number of the Wiretap server. Returns 0 if the value has not been set.

§ getProductVersionMaint()

int WireTapServerInfo::getProductVersionMaint ( ) const

Gets the maintenance version of the Wiretap server.

Returns
An integer that is the maintenance version of the Wiretap server. Returns 0 if the version is not a maintenance release.

§ getProductVersionMajor()

int WireTapServerInfo::getProductVersionMajor ( ) const

Gets the major version of the Wiretap server.

Returns
An integer that is the major version of the Wiretap server.

§ getProductVersionMinor()

int WireTapServerInfo::getProductVersionMinor ( ) const

Gets the minor version of the Wiretap server.

Returns
An integer that is the minor version of the Wiretap server. Returns 0 if the version is not a minor release.

§ getProductVersionStr()

const char* WireTapServerInfo::getProductVersionStr ( ) const

Gets a string that describes the full version of the server product.

Returns
A string that describes the product version. It may be a concatenation of the major, minor, and maintenance versions, and the product build.

§ getStorageId()

const char* WireTapServerInfo::getStorageId ( ) const

Gets the ID of the storage device that is currently connected to the server.

Returns
The ID of the storage device connected to the server.

§ getVendor()

const char* WireTapServerInfo::getVendor ( ) const

Gets the vendor of the server product.

Returns
A string that contains the name of the company that sells the Wiretap server.

§ getVersionMaint()

int WireTapServerInfo::getVersionMaint ( ) const

Gets the minor version of the protocol (for internal use).

Returns
An integer that indicates the minor release of the protocol. Returns 0 if the version of the protocol is not a maintenance release.

§ getVersionMajor()

int WireTapServerInfo::getVersionMajor ( ) const

Gets the major version of the protocol (for internal use).

Returns
An integer that indicates the major release of the protocol.

§ getVersionMinor()

int WireTapServerInfo::getVersionMinor ( ) const

Gets the minor version of the protocol (for internal use).

Returns
An integer that indicates the minor release of the protocol. Returns 0 version of the protocol is not a minor release.

§ isLocal()

bool WireTapServerInfo::isLocal ( ) const
Returns
true if the server info points to a local server.

§ isSameServer() [1/2]

bool WireTapServerInfo::isSameServer ( const WireTapServerId id) const
Returns
true if server id point to same server
Parameters
[in]idServer Id to compare to.

§ isSameServer() [2/2]

bool WireTapServerInfo::isSameServer ( const WireTapServerInfo info) const
Returns
true if both server info point to same server
Parameters
[in]infoServer info to compare to.

§ operator=()

WireTapServerInfo& WireTapServerInfo::operator= ( const WireTapServerInfo src)

Default assignment operator.

Returns a reference to the source object.

Parameters
srcAn input parameter. The WireTapServerInfo object to which the reference should point.

§ operator==()

bool WireTapServerInfo::operator== ( const WireTapServerInfo other) const

Default equal operator.

Returns a reference to the source object.

Parameters
otherAn input parameter. The WireTapServerInfo object to which the reference should be compared.

§ setDatabase()

void WireTapServerInfo::setDatabase ( const char *  database)

Sets the type of database exposed by the server.

Parameters
databaseAn input parameter. A string that describes the database used by the server. For example, IFFFS or Backburner.

§ setProduct()

void WireTapServerInfo::setProduct ( const char *  product)

Sets an identifier for the server product.

Parameters
productAn input parameter. A string that identifies the server product.

§ setProductBuild()

void WireTapServerInfo::setProductBuild ( int  build)

Sets the build number of the server product.

Parameters
buildAn input parameter. An integer that is the build number of the server product.

§ setProductVersionMaint()

void WireTapServerInfo::setProductVersionMaint ( int  maint)

Sets the maintenance version of the server product.

Parameters
maintAn input parameter. An integer that is the maintenance version of the server product. Optional.

§ setProductVersionMajor()

void WireTapServerInfo::setProductVersionMajor ( int  major)

Sets the major version of the server product.

Parameters
majorAn input parameter. An integer that is the major version of the server product.

§ setProductVersionMinor()

void WireTapServerInfo::setProductVersionMinor ( int  minor)

Sets the minor version of the server product.

Parameters
minorAn input parameter. An integer that is the minor version of the server product. Optional.

§ setProductVersionStr()

void WireTapServerInfo::setProductVersionStr ( const char *  version)

Sets a string that describes the full version of the server product.

Parameters
versionAn input parameter. A string that describes the full version of the server product.

§ setStorageId()

void WireTapServerInfo::setStorageId ( const char *  storageId)

Sets the ID of the storage device connected to the server.

This method only keeps a record of the storage device ID as part of the information about the server. It does not modify anything on the storage device itself.

Parameters
storageIdAn input parameter. ID of the storage device currently connected to the server.

§ setVendor()

void WireTapServerInfo::setVendor ( const char *  vendor)

Sets the vendor of the server product.

Parameters
vendorAn input parameter. A string that contains the name of the company that sells the Wiretap server.

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