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 |
WireTapServerInfo & | operator= (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... | |
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.
WireTapServerInfo::WireTapServerInfo | ( | ) |
Constructs a WireTapServerInfo object.
WireTapServerInfo::WireTapServerInfo | ( | const WireTapServerInfo & | info | ) |
Copy constructor.
Constructs a new WireTapServerInfo object duplicating the content of the original.
info | An input parameter. The WiretapServerInfo object that is to be copied. |
WireTapServerInfo::~WireTapServerInfo | ( | ) |
Destructor.
const char* WireTapServerInfo::getDatabase | ( | ) | const |
Gets the type of database exposed by the server.
const char* WireTapServerInfo::getDisplayName | ( | ) | const |
Gets the display name of the server, which is usually just the host name.
const char* WireTapServerInfo::getHostname | ( | ) | const |
Gets the name of the host machine on which the server is running.
const char* WireTapServerInfo::getHostUUID | ( | ) | const |
WireTapServerId WireTapServerInfo::getId | ( | ) | const |
Gets an instance of WireTapServerId which contains all the information used to define a persistent ID for the Wiretap server.
const char* WireTapServerInfo::getProduct | ( | ) | const |
Gets an identifier for the server product.
int WireTapServerInfo::getProductBuild | ( | ) | const |
Gets the build of the server product.
int WireTapServerInfo::getProductVersionMaint | ( | ) | const |
Gets the maintenance version of the Wiretap server.
int WireTapServerInfo::getProductVersionMajor | ( | ) | const |
Gets the major version of the Wiretap server.
int WireTapServerInfo::getProductVersionMinor | ( | ) | const |
Gets the minor version of the Wiretap server.
const char* WireTapServerInfo::getProductVersionStr | ( | ) | const |
Gets a string that describes the full version of the server product.
const char* WireTapServerInfo::getStorageId | ( | ) | const |
Gets the ID of the storage device that is currently connected to the server.
const char* WireTapServerInfo::getVendor | ( | ) | const |
Gets the vendor of the server product.
int WireTapServerInfo::getVersionMaint | ( | ) | const |
Gets the minor version of the protocol (for internal use).
int WireTapServerInfo::getVersionMajor | ( | ) | const |
Gets the major version of the protocol (for internal use).
int WireTapServerInfo::getVersionMinor | ( | ) | const |
Gets the minor version of the protocol (for internal use).
bool WireTapServerInfo::isLocal | ( | ) | const |
bool WireTapServerInfo::isSameServer | ( | const WireTapServerId & | id | ) | const |
[in] | id | Server Id to compare to. |
bool WireTapServerInfo::isSameServer | ( | const WireTapServerInfo & | info | ) | const |
[in] | info | Server info to compare to. |
WireTapServerInfo& WireTapServerInfo::operator= | ( | const WireTapServerInfo & | src | ) |
Default assignment operator.
Returns a reference to the source object.
src | An input parameter. The WireTapServerInfo object to which the reference should point. |
bool WireTapServerInfo::operator== | ( | const WireTapServerInfo & | other | ) | const |
Default equal operator.
Returns a reference to the source object.
other | An input parameter. The WireTapServerInfo object to which the reference should be compared. |
void WireTapServerInfo::setDatabase | ( | const char * | database | ) |
Sets the type of database exposed by the server.
database | An input parameter. A string that describes the database used by the server. For example, IFFFS or Backburner. |
void WireTapServerInfo::setProduct | ( | const char * | product | ) |
Sets an identifier for the server product.
product | An input parameter. A string that identifies the server product. |
void WireTapServerInfo::setProductBuild | ( | int | build | ) |
Sets the build number of the server product.
build | An input parameter. An integer that is the build number of the server product. |
void WireTapServerInfo::setProductVersionMaint | ( | int | maint | ) |
Sets the maintenance version of the server product.
maint | An input parameter. An integer that is the maintenance version of the server product. Optional. |
void WireTapServerInfo::setProductVersionMajor | ( | int | major | ) |
Sets the major version of the server product.
major | An input parameter. An integer that is the major version of the server product. |
void WireTapServerInfo::setProductVersionMinor | ( | int | minor | ) |
Sets the minor version of the server product.
minor | An input parameter. An integer that is the minor version of the server product. Optional. |
void WireTapServerInfo::setProductVersionStr | ( | const char * | version | ) |
Sets a string that describes the full version of the server product.
version | An input parameter. A string that describes the full version of the server product. |
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.
storageId | An input parameter. ID of the storage device currently connected to the server. |
void WireTapServerInfo::setVendor | ( | const char * | vendor | ) |
Sets the vendor of the server product.
vendor | An input parameter. A string that contains the name of the company that sells the Wiretap server. |