xeps/xep-0296.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Best Practices for Resource Locking</title>
  <abstract>This document specifies best practices to be followed by Jabber/XMPP clients about when to lock into, and unlock away from, resources.</abstract>
  &LEGALNOTICE;
  <number>0296</number>
  <status>Experimental</status>
  <lastcall>2011-08-05</lastcall>
  <type>Informational</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0085</spec>
    <spec>XEP-0201</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  <author>
    <firstname>Matthew </firstname>
    <surname>Miller</surname>
    <email>linuxwolf@outer-planes.net</email>
    <jid>linuxwolf@outer-planes.net</jid>
  </author>
  <revision>
    <version>0.2</version>
    <date>2011-08-18</date>
    <initials>mam</initials>
    <remark><p>Expanded intro with a short problem description; moved chat states considerations to their own section; tightened requirement regarding a message from different resource from MAY to SHOULD; loosened requirement regarding a message with 'gone' from MUST to SHOULD; added missing but required sections</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2011-04-11</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2011-03-14</date>
    <initials>mm</initials>
    <remark><p>Initial draft</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>The goal of this specification is to provide implementation guidance for XMPP clients to improve the user experience when maintaining a chat conversation between the user and a conversee. Section 5.1 of &xmppim; defines the concept of a "one-to-one chat session" and recommends that clients support the behavior described there, including:</p>
  <ol>
   <li>Send the first message in a chat session to the bare JID &LOCALBARE; of the intended recipient</li>
   <li>Send messages to the full JID &LOCALFULL; only after receiving a reply from the recipient (this is called "locking" into that full JID).</li>
   <li>Send messages to the bare JID again if the presence of the recipient changes in any way (this is called "unlocking" from the full JID).</li>
  </ol>
  <p>However, following only these guidelines can still lead to "disjointed" chat conversations in clients, epsecially if multiple resources are in play.</p>
  <p>This specification reinforces the recommendations from XMPP-IM and provides additional implementation guidance to developers of XMPP clients.</p>
</section1>
<section1 topic='General Rules' anchor='general'>
  <!-- <p>TODO: simple state chart</p> -->
  <section2 topic='Initial Conversation State' anchor='general-nolock'>
      <p>A client MUST start conversations in the unlocked state. In this state, a client MUST send &MESSAGE;s to a conversee's bare JID.</p>
  </section2>
  <section2 topic='Locking a Conversation' anchor='general-lock'>
    <p>Once a client receives a chat &MESSAGE; from the conversee, whether or not this client initiated the conversation, it MUST lock the conversation. The client MUST remember the conversee's full JID and send further correspondence to this full JID until one of the unlocking conditions are met.</p>
  </section2>
  <section2 topic='Unlocking a Conversation' anchor='general-unlock'>
    <p>A client MUST unlock a chat session from a resource when one of the following conditions is met:</p>
    <ul>
      <li>A &MESSAGE; from the same bare JID, but a different resource, is received. In this case, the client SHOULD lock to the new resource; or the client MAY revert to the initial state, sending any following correspondence to the conversee's bare JID.</li>
      <li>any &PRESENCE; update from any resource for the conversee's bare JID, including &lt;presence type='unavailable'/&gt;. The client SHOULD revert to the initial state,  sending any following correspondence to the conversee's bare JID.</li>
    </ul>
  </section2>
  <section2 topic='Interactions with Chat States' id='interact-csn'>
    <p>If a client supports &xep0085;, then the following additional considerations apply:</p>
    <ul>
      <li>If a client receives a &MESSAGE; with a &lt;gone xmlns='http://jabber.org/protocol/chatstates'/&gt; chat state, it SHOULD unlock the coversation.</li>
    </ul>
  </section2>
</section1>
<section1 topic='User Agent Implementation Notes' anchor='impl'>
  <p>This section is non-normative, but provides additional guidelines for clients that interact directly with users.</p>
  <section2 topic='User Experience Considerations' anchor='experience'>
   <p>To further improve the user experience, clients are strongly encouraged to implement Chat State Notifications and adhere to the recommendations from &xep0201;.</p>
 </section2>
 <section2 topic='Idle Conversations' anchor='idle-chat'>
    <p>A client MAY take into account the lack of activity of a conversation. Exactly how much inactivity constitutes an idle conversation is left to implementations to determine.</p>
  </section2>
  <section2 topic='Overall Inactivity' anchor='idle-user'>
    <p>A client MAY take into account the overall lack of activity of a user, in which case it is RECOMMENDED the client send a &PRESENCE; update to trigger any conversations to unlock. The exact conditions and &PRESENCE; information conveyed is left to implementations to determine.</p>
  </section2>
  <!-- <section2 topic='Mobile Considerations' anchor='mobile'>
    <p>TODO: notes on mobile clients (aggressiveness of unlocking, interactions with &xep0273;?)</p>
  </section2> -->
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <p>This document introduces no known security vulnerabilities.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>This document requires no interaction with the &REGISTRAR;.</p>
</section1>
</xep>