BIND 10 trac2676, updated. ff2215ffb7e7149c50764841e00d8d9186a81294 [2676] Document the rpc_call

[BIND 10 source code commits]

The branch, trac2676 has been updated
       via  ff2215ffb7e7149c50764841e00d8d9186a81294 (commit)
      from  6667c5c3485db2ec1da350d4b90896b871e07bad (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 ff2215ffb7e7149c50764841e00d8d9186a81294
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date:   Thu Feb 14 14:06:32 2013 +0100

    [2676] Document the rpc_call

-----------------------------------------------------------------------

Summary of changes:
 src/lib/python/isc/config/ccsession.py |   22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

-----------------------------------------------------------------------
diff --git a/src/lib/python/isc/config/ccsession.py b/src/lib/python/isc/config/ccsession.py
index 529408c..10e5e8c 100644
--- a/src/lib/python/isc/config/ccsession.py
+++ b/src/lib/python/isc/config/ccsession.py
@@ -502,6 +502,28 @@ class ModuleCCSession(ConfigData):
 
     def rpc_call(self, command, group, instance=CC_INSTANCE_WILDCARD,
                  to=CC_TO_WILDCARD, **params):
+        """
+        Create a command with the given name and parameters. Send it to a
+        recipient, wait for the answer and parse it.
+
+        This is a wrapper around the group_sendmsg and group_recvmsg on the CC
+        session. It exists mostly for convenience.
+
+        Params:
+        - command: Name of the command to call on the remote side.
+        - group, instance, to: Address specification of the recipient.
+        - params: Parameters to pass to the command (as keyword arguments).
+
+        Return: The return value of the remote call (just the value, no status
+          code or anything). May be None.
+
+        Raise:
+        - RPCRecipientMissing if the given recipient doesn't exist.
+        - RPCError if the other side sent an error response. The error string
+          is in the exception.
+        - ModuleCCSessionError in case of protocol errors, like malformed
+          answer.
+        """
         cmd = create_command(command, params)
         seq = self._session.group_sendmsg(cmd, group, instance=instance,
                                           to=to, want_answer=True)