From: Michal 'vorner' Vaner Date: Wed, 21 Dec 2011 15:50:57 +0000 (+0100) Subject: [805] Update the documentation X-Git-Tag: trac2351_base~304^2~16^2~32 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9ec8253a3af8de3f85b1bce0ebabc88b7fa5a746;p=thirdparty%2Fkea.git [805] Update the documentation --- diff --git a/src/lib/server_common/portconfig.h b/src/lib/server_common/portconfig.h index e4e7bf6570..0c0fa6a2de 100644 --- a/src/lib/server_common/portconfig.h +++ b/src/lib/server_common/portconfig.h @@ -96,10 +96,12 @@ parseAddresses(isc::data::ConstElementPtr addresses, * * If it fails to set up the new addresses, it attempts to roll back to the * previous addresses (but it still propagates the exception). If the rollback - * fails as well, it aborts the application (it assumes if it can't listen - * on the new addresses nor on the old ones, the application is useless anyway - * and should be restarted by Boss, not to mention that the internal state is - * probably broken). + * fails as well, it doesn't abort the application (to allow reconfiguration), + * but removes all the sockets it listened on. One of the exceptions is + * propagated. + * + * The ports are requested from the socket creator through boss. Therefore + * you need to initialize the SocketRequestor before using this function. * * \param newAddresses are the addresses you want to listen on. * \param addressStore is the place you store your current addresses. It is @@ -109,7 +111,11 @@ parseAddresses(isc::data::ConstElementPtr addresses, * the new sockets are handled using this dnsService (and all current * sockets on the service are closed first). * \throw asiolink::IOError when initialization or closing of socket fails. + * \throw isc::server_common::SocketRequestor::Socket error when the + * boss/socket creator doesn't want to give us the socket. * \throw std::bad_alloc when allocation fails. + * \throw isc::InvalidOperation when the function is called and the + * SocketRequestor isn't initialized yet. */ void installListenAddresses(const AddressList& newAddresses,