Update the RPC cast() documentation.

Be explicit about the lack of ordering guarantees across sucessive
casts to the same destination.

Change-Id: I79927d27666331fc57e262562ead51168944ec1c
This commit is contained in:
Kenneth Giusti 2016-04-22 10:57:21 -04:00
parent 715b5b1c3f
commit 41dd8e3af3
1 changed files with 7 additions and 3 deletions

View File

@ -355,9 +355,13 @@ class RPCClient(object):
Similarly, the request context must be a dict unless the client's
serializer supports serializing another type.
Note: cast doesn't ensure the remote method to be been executed
on each destination. But ensures that it will be not executed twice
on a destination.
Note: cast does not ensure that the remote method will be executed on
each destination. But it does ensure that the method will be not
executed twice on a destination (e.g. 'at-most-once' execution).
Note: there are no ordering guarantees across successive casts, even
among casts to the same destination. Therefore methods may be executed
in an order different from the order in which they are cast.
:param ctxt: a request context dict
:type ctxt: dict