From 5ab77c745270d7d5c016c1dc7ef2a82533a4b16e Mon Sep 17 00:00:00 2001 From: Florent Le Coz Date: Thu, 17 Jul 2014 14:19:04 +0200 Subject: Rename to slixmpp --- docs/getting_started/sendlogout.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/getting_started/sendlogout.rst') diff --git a/docs/getting_started/sendlogout.rst b/docs/getting_started/sendlogout.rst index a1352db9..5b23a469 100644 --- a/docs/getting_started/sendlogout.rst +++ b/docs/getting_started/sendlogout.rst @@ -5,25 +5,25 @@ Sign in, Send a Message, and Disconnect If you have any issues working through this quickstart guide or the other tutorials here, please either send a message to the - `mailing list `_ + `mailing list `_ or join the chat room at `sleek@conference.jabber.org `_. -A common use case for SleekXMPP is to send one-off messages from +A common use case for Slixmpp is to send one-off messages from time to time. For example, one use case could be sending out a notice when a shell script finishes a task. We will create our one-shot bot based on the pattern explained in :ref:`echobot`. To -start, we create a client class based on :class:`ClientXMPP ` and +start, we create a client class based on :class:`ClientXMPP ` and register a handler for the :term:`session_start` event. We will also accept parameters for the JID that will receive our message, and the string content of the message. .. code-block:: python - import sleekxmpp + import slixmpp - class SendMsgBot(sleekxmpp.ClientXMPP): + class SendMsgBot(slixmpp.ClientXMPP): def __init__(self, jid, password, recipient, msg): super(SendMsgBot, self).__init__(jid, password) @@ -38,7 +38,7 @@ for the JID that will receive our message, and the string content of the message self.get_roster() Note that as in :ref:`echobot`, we need to include send an initial presence and request -the roster. Next, we want to send our message, and to do that we will use :meth:`send_message `. +the roster. Next, we want to send our message, and to do that we will use :meth:`send_message `. .. code-block:: python @@ -48,12 +48,12 @@ the roster. Next, we want to send our message, and to do that we will use :meth: self.send_message(mto=self.recipient, mbody=self.msg) -Finally, we need to disconnect the client using :meth:`disconnect `. +Finally, we need to disconnect the client using :meth:`disconnect `. Now, sent stanzas are placed in a queue to pass them to the send thread. If we were to call -:meth:`disconnect ` without any parameters, then it is possible +:meth:`disconnect ` without any parameters, then it is possible for the client to disconnect before the send queue is processed and the message is actually sent on the wire. To ensure that our message is processed, we use -:meth:`disconnect(wait=True) `. +:meth:`disconnect(wait=True) `. .. code-block:: python @@ -68,7 +68,7 @@ sent on the wire. To ensure that our message is processed, we use .. warning:: If you happen to be adding stanzas to the send queue faster than the send thread - can process them, then :meth:`disconnect(wait=True) ` + can process them, then :meth:`disconnect(wait=True) ` will block and not disconnect. Final Product -- cgit v1.2.3