BIND 10 trac742, updated. 8081aaf24a0fb181f2847887ba6347d7c97969e5 [trac742] Documentation comment
BIND 10 source code commits
bind10-changes at lists.isc.org
Mon Jun 27 15:16:11 UTC 2011
The branch, trac742 has been updated
via 8081aaf24a0fb181f2847887ba6347d7c97969e5 (commit)
via 68b13c93af35910580e0ab42ad2081b212e8d5eb (commit)
via 0c9a11c009aec896872bf4914bd5f01e40a5e0ae (commit)
from 8266c873258135c402a7cae57e409742a2cc1ace (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 8081aaf24a0fb181f2847887ba6347d7c97969e5
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date: Mon Jun 27 17:15:43 2011 +0200
[trac742] Documentation comment
commit 68b13c93af35910580e0ab42ad2081b212e8d5eb
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date: Mon Jun 27 17:12:36 2011 +0200
[trac742] Message descriptions
commit 0c9a11c009aec896872bf4914bd5f01e40a5e0ae
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date: Mon Jun 27 16:47:26 2011 +0200
[trac742] Sort the messages alphabetically
-----------------------------------------------------------------------
Summary of changes:
src/lib/cc/cc_messages.mes | 93 +++++++++++++++++++++++++++++++++----------
src/lib/cc/logger.h | 13 ++++++
2 files changed, 84 insertions(+), 22 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/lib/cc/cc_messages.mes b/src/lib/cc/cc_messages.mes
index de05169..5c60727 100644
--- a/src/lib/cc/cc_messages.mes
+++ b/src/lib/cc/cc_messages.mes
@@ -14,46 +14,95 @@
$NAMESPACE isc::cc
-% CC_CONN_ERROR error connecting to message queue (%1)
-
-% CC_NO_MSGQ unable to connect to message queue (%1)
+% CC_ASYNC_READ_FAILED asynchronous read failed
+This marks a low level error, we tried to read data from the message queue
+daemon asynchronously, but the ASIO library returned an error.
-% CC_WRITE_ERROR error writing data to command channel (%1)
+% CC_CONN_ERROR error connecting to message queue (%1)
+It is impossible to reach the message queue daemon for the reason given. It
+is unlikely there'll be reason for whatever program this currently is to
+continue running, as the communication with the rest of BIND 10 is vital
+for the components.
-% CC_LENGTH_NOT_READY length not ready
+% CC_DISCONNECT disconnecting from message queue daemon
+The library is disconnecting from the message queue daemon. This debug message
+indicates that the program is trying to shut down gracefully.
-% CC_READ_EXCEPTION error reading data from command channel (%1)
+% CC_ESTABLISH trying to establish connection with message queue daemon at %1
+This is debug message and indicates that the command channel library is about
+connect to the message queue daemon, which should be listening on UNIX-domain
+socket listed in the output.
-% CC_TIMEOUT timeout reading data from command channel
+% CC_ESTABLISHED successfully connected to message queue daemon
+This debug message indicates that the connection was successfully made, this
+should follow CC_ESTABLISH.
-% CC_READ_ERROR error reading data from command channel (%1)
+% CC_GROUP_RECEIVE trying to receive a message
+Debug message, noting that a message is expected to come over the command
+channel.
-% CC_ZERO_LENGTH invalid message length (0)
+% CC_GROUP_RECEIVED message arrived ('%1', '%2')
+Debug message, noting that we successfully received a message (its envelope and
+payload listed). This follows CC_GROUP_RECEIVE, but might happen some time
+later, depending if we waited for it or just polled.
-% CC_ASYNC_READ_FAILED asynchronous read failed
+% CC_GROUP_SEND sending message '%1' to group '%2'
+Debug message, we're about to send a message over the command channel.
% CC_INVALID_LENGTHS invalid length parameters (%1, %2)
+This happens when garbage comes over the command channel or some kind of
+confusion happens in the program. The data received from the socket make no
+sense if we interpret it as lengths of message. The first one is total length
+of message, the second length of the header. The header and it's length
+(2 bytes) is counted in the total length.
-% CC_ESTABLISH trying to establish connection with message queue daemon at %1
+% CC_LENGTH_NOT_READY length not ready
+There should be data representing length of message on the socket, but it
+is not there.
-% CC_ESTABLISHED successfully connected to message queue daemon
+% CC_NO_MESSAGE no message ready to be received yet
+The program polled for incoming messages, but there was no message waiting.
+This is a debug message which may happen only after CC_GROUP_RECEIVE.
-% CC_DISCONNECT disconnecting from message queue daemon
+% CC_NO_MSGQ unable to connect to message queue (%1)
+It isn't possible to connect to the message queue daemon, for reason listed.
+It is unlikely any program will be able continue without the communication.
-% CC_START_READ starting asynchronous read
+% CC_READ_ERROR error reading data from command channel (%1)
+A low level error happened when the library tried to read data from command
+channel socket. The reason is listed.
-% CC_SUBSCRIBE subscribing to communication group %1
+% CC_READ_EXCEPTION error reading data from command channel (%1)
+We received an exception while trying to read data from command channel socket.
+The reason is listed.
-% CC_UNSUBSCRIBE unsubscribing from communication group %1
+% CC_REPLY replying to message from '%1' with '%2'
+Debug message, noting we're sending a response to original message with given
+envelope.
-% CC_GROUP_SEND sending message '%1' to group '%2'
+% CC_SET_TIMEOUT setting timeout to %1ms
+Debug message. A timeout for which the program is willing to wait for a reply
+is being set.
-% CC_GROUP_RECEIVE trying to receive a message
+% CC_START_READ starting asynchronous read
+Debug message. From now on, when a message (or command) comes, it'll wake the
+program and the library will automatically pass it over to correct place.
-% CC_GROUP_RECEIVED message arrived ('%1', '%2')
+% CC_SUBSCRIBE subscribing to communication group %1
+Debug message. The program wants to receive messages addressed to this group.
-% CC_NO_MESSAGE no message ready to be received yet
+% CC_TIMEOUT timeout reading data from command channel
+The program waited too long for data from the command channel (usually when it
+sent a query to different program and it didn't answer for whatever reason).
-% CC_REPLY replying to message from '%1' with '%2'
+% CC_UNSUBSCRIBE unsubscribing from communication group %1
+Debug message. The program no longer wants to receive messages addressed to
+this group.
-% CC_SET_TIMEOUT setting timeout to %1ms
+% CC_WRITE_ERROR error writing data to command channel (%1)
+A low level error happened when the library tried to write data to the command
+channel socket.
+
+% CC_ZERO_LENGTH invalid message length (0)
+The library received a message length being zero, which makes no sense, since
+all messages must contain at last the envelope.
diff --git a/src/lib/cc/logger.h b/src/lib/cc/logger.h
index 5ef48f8..567ccee 100644
--- a/src/lib/cc/logger.h
+++ b/src/lib/cc/logger.h
@@ -18,14 +18,27 @@
#include <cc/cc_messages.h>
#include <log/macros.h>
+/// \file logger.h
+/// \brief Command Channel library global logger
+///
+/// This holds the logger for the CC library. It is a private header
+/// and should not be included in any publicly used header, only in local
+/// cc files.
+
namespace isc {
namespace cc {
enum {
+ /// \brief Trace basic operation
DBG_TRACE_BASIC = 10,
+ /// \brief Trace even details
+ ///
+ /// This includes messages being sent and received, waiting for messages
+ /// and alike.
DBG_TRACE_DETAILED = 80
};
+/// \brief Logger for this library
extern isc::log::Logger logger;
}
More information about the bind10-changes
mailing list