Module io.netty5.handler

Package io.netty5.handler.ssl

Class SslHandshakeCompletionEvent

java.lang.Object

io.netty5.handler.ssl.SslCompletionEvent

io.netty5.handler.ssl.SslHandshakeCompletionEvent

All Implemented Interfaces:

ProtocolEvent

public final class SslHandshakeCompletionEvent
extends SslCompletionEvent

Event that is fired once the SSL handshake is complete, which may be because it was successful or there was an error.

Constructor Summary

Constructors

Constructor	Description
SslHandshakeCompletionEvent(Throwable cause)	Creates a new event that indicates an unsuccessful handshake.
SslHandshakeCompletionEvent(SSLSession session, String applicationProtocol)	Creates a new event that indicates a successful handshake.
SslHandshakeCompletionEvent(SSLSession session, String applicationProtocol, Throwable cause)	Creates a new event that indicates an unsuccessful handshake.

Method Summary

Modifier and Type	Method	Description
String	applicationProtocol()	Return the application protocol that was selected or null if none was selected.
SSLSession	session()	Returns the SSLSession in case of ProtocolEvent.isSuccess() to be true, null in case of a failure.

Methods inherited from class io.netty5.handler.ssl.SslCompletionEvent

cause, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty5.handler.codec.ProtocolEvent

isFailed, isSuccess

Constructor Detail

SslHandshakeCompletionEvent

public SslHandshakeCompletionEvent(SSLSession session,
                                   String applicationProtocol)

Creates a new event that indicates a successful handshake.

Parameters:

session - the SSLSession for the handshake.

applicationProtocol - the application protocol that was selected (if any).

SslHandshakeCompletionEvent

public SslHandshakeCompletionEvent(SSLSession session,
                                   String applicationProtocol,
                                   Throwable cause)

Creates a new event that indicates an unsuccessful handshake.

Parameters:

session - the SSLSession for the handshake.

applicationProtocol - the application protocol that was selected (if any).

cause - the cause of the failure.

SslHandshakeCompletionEvent

public SslHandshakeCompletionEvent(Throwable cause)

Creates a new event that indicates an unsuccessful handshake.

Parameters:

cause - the cause of the failure.

Method Detail

session

public SSLSession session()

Returns the SSLSession in case of ProtocolEvent.isSuccess() to be true, null in case of a failure.

Overrides:

session in class SslCompletionEvent

Returns:

the session.

applicationProtocol

public String applicationProtocol()

Return the application protocol that was selected or null if none was selected.

Returns:

the application protocol.