Changeset 10389 for trunk

Timestamp:

04/18/11 14:30:23 (14 years ago)

Author:

tbretz

Message:

Added descriptions for the virtual function.

File:

• trunk/FACT++/src/DimServerList.h (modified) (1 diff)

trunk/FACT++/src/DimServerList.h

@@ -35 +35 @@
 
 #endif
+
+// ***************************************************************************
+/** @fn DimServerList::AddServer(const std::string &server)
+
+This virtual function is called as a callback whenever a new server appears
+to be available on the dns.
+
+The default is to do nothing.
+
+@param server
+   Server name of the server which was added
+
+**/
+// ***************************************************************************
+/** @fn DimServerList::RemoveServer(const std::string &server)
+
+This virtual function is called as a callback whenever a server disappears
+from the dns.
+
+The default is to do nothing.
+
+@param server
+   Server name of the server which was removed
+
+
+**/
+// ***************************************************************************
+/** @fn DimServerList::RemoveAllServers()
+
+This virtual function is called as a callback whenever a all servers
+disappear, e.g. the dns has vanished.
+
+The default is to do nothing.
+
+
+**/
+// ***************************************************************************