summaryrefslogtreecommitdiff
path: root/docs/differences.rst
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2015-02-28 13:34:52 +0100
committermathieui <mathieui@mathieui.net>2015-02-28 19:02:35 +0100
commitbf5d7c83af320b7af629857aab7060302abfabf5 (patch)
tree548e088aae38c780300b7f10fc7eec092db33a1a /docs/differences.rst
parentc66a4d4097a249efc029b761d6150378a54bf702 (diff)
downloadslixmpp-bf5d7c83af320b7af629857aab7060302abfabf5.tar.gz
slixmpp-bf5d7c83af320b7af629857aab7060302abfabf5.tar.bz2
slixmpp-bf5d7c83af320b7af629857aab7060302abfabf5.tar.xz
slixmpp-bf5d7c83af320b7af629857aab7060302abfabf5.zip
Change the API to make iq.send() always return a future
remove coroutine_wrapper, add a future_wrapper (which is only needed when the result stanza can be cached). Update the documentation as well.
Diffstat (limited to 'docs/differences.rst')
-rw-r--r--docs/differences.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/differences.rst b/docs/differences.rst
index e6e26d2c..f6e005b5 100644
--- a/docs/differences.rst
+++ b/docs/differences.rst
@@ -32,12 +32,12 @@ Differences from SleekXMPP
handlers, which will be also handled in the event loop.
The :class:`~.slixmpp.stanza.Iq` object’s :meth:`~.slixmpp.stanza.Iq.send`
- method now takes a *coroutine* parameter which, if set to ``True``,
- will return a coroutine which will (asyncio-)block until the reply
- is received.
+ method now **always** return a :class:`~.asyncio.Future` which result will be set
+ to the IQ reply when it is received, or to ``None`` if the IQ is not of
+ type ``get`` or ``set``.
- Many plugins (WIP) calls which retrieve information also accept this
- ``coroutine`` parameter.
+ Many plugins (WIP) calls which retrieve information also return the same
+ future.
**Architectural differences**
slixmpp does not have an event queue anymore, and instead processes