Changeset 10389


Ignore:
Timestamp:
Apr 18, 2011, 2:30:23 PM (9 years ago)
Author:
tbretz
Message:
Added descriptions for the virtual function.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/FACT++/src/DimServerList.h

    r10378 r10389  
    3535
    3636#endif
     37
     38// ***************************************************************************
     39/** @fn DimServerList::AddServer(const std::string &server)
     40
     41This virtual function is called as a callback whenever a new server appears
     42to be available on the dns.
     43
     44The default is to do nothing.
     45
     46@param server
     47   Server name of the server which was added
     48
     49**/
     50// ***************************************************************************
     51/** @fn DimServerList::RemoveServer(const std::string &server)
     52
     53This virtual function is called as a callback whenever a server disappears
     54from the dns.
     55
     56The default is to do nothing.
     57
     58@param server
     59   Server name of the server which was removed
     60
     61
     62**/
     63// ***************************************************************************
     64/** @fn DimServerList::RemoveAllServers()
     65
     66This virtual function is called as a callback whenever a all servers
     67disappear, e.g. the dns has vanished.
     68
     69The default is to do nothing.
     70
     71
     72**/
     73// ***************************************************************************
Note: See TracChangeset for help on using the changeset viewer.