Improved javadocs for onPreface().

This commit is contained in:
Simone Bordet 2015-11-25 12:51:03 +01:00
parent 204591ce82
commit f596bf1566
1 changed files with 9 additions and 2 deletions

View File

@ -134,11 +134,18 @@ public interface Session
public interface Listener
{
/**
* <p>Callback method invoked when the preface has been received.</p>
* <p>Callback method invoked:</p>
* <ul>
* <li>for clients, just before the preface is sent, to gather the
* SETTINGS configuration options the client wants to send to the server;</li>
* <li>for servers, just after having received the preface, to gather
* the SETTINGS configuration options the server wants to send to the
* client.</li>
* </ul>
*
* @param session the session
* @return a (possibly empty or null) map containing SETTINGS configuration
* options that are sent after the preface.
* options to send.
*/
public Map<Integer, Integer> onPreface(Session session);