andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove missleading javadoc

Browse Source 
Motivation:

Its completely fine to start writing before the handshake completes when using SslHandler. The writes will be just queued.

Modifications:

Remove the missleading and incorrect javadoc.

Result:

Correct javadoc.
This commit is contained in:
Norman Maurer 2016-08-12 14:31:23 +02:00
parent f73c4f24ee
commit 00deb2efd5
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
handler/src/main/java/io/netty/handler/ssl/SslHandler.java
View File

@ -75,12 +75,7 @@ import static io.netty.handler.ssl.SslUtils.getEncryptedPacketLength;
* *
* <h3>Beginning the handshake</h3> * <h3>Beginning the handshake</h3>
* <p> * <p>
* You must make sure not to write a message while the handshake is in progress unless you are * Beside using the handshake {@link ChannelFuture} to get notified about the completion of the handshake it's
* renegotiating. You will be notified by the {@link Future} which is
* returned by the {@link #handshakeFuture()} method when the handshake
* process succeeds or fails.
* <p>
* Beside using the handshake {@link ChannelFuture} to get notified about the completation of the handshake it's
* also possible to detect it by implement the * also possible to detect it by implement the
* {@link ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object)} * {@link ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object)}
* method and check for a {@link SslHandshakeCompletionEvent}. * method and check for a {@link SslHandshakeCompletionEvent}.