svn commit: r1423839 - /qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java

[ph...@apache.org]

Author: philharveyonline
Date: Wed Dec 19 12:23:54 2012
New Revision: 1423839

URL: http://svn.apache.org/viewvc?rev=1423839&view=rev
Log:
NO-JIRA: Improve Transport JavaDoc.

Modified:
    qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java

Modified: qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java
URL: http://svn.apache.org/viewvc/qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java?rev=1423839&r1=1423838&r2=1423839&view=diff
==============================================================================
--- qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java (original)
+++ qpid/proton/trunk/proton-j/proton-api/src/main/java/org/apache/qpid/proton/engine/Transport.java Wed Dec 19 12:23:54 2012
@@ -62,6 +62,9 @@ public interface Transport extends Endpo
     /**
      * Wrap this transport's output and input to apply SSL encryption and decryption respectively.
      *
+     * This method is expected to be called at most once. A subsequent invocation will return the same
+     * {@link Ssl} object, regardless of the parameters supplied.
+     *
      * @param sslDomain the SSL settings to use
      * @param sslPeerDetails may be null, in which case SSL session resume will not be attempted
      * @return an {@link Ssl} object representing the SSL session.



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org