Top Description Fields Constructors Methods

io.netty5.handler.codec.http.websocketx

public abstract Class WebSocketHandshakeCompletionEvent

Class Inheritance

extends Object
implements ProtocolEvent

java.lang.Object
io.netty5.handler.codec.http.websocketx.WebSocketHandshakeCompletionEvent

All Implemented Interfaces

io.netty5.handler.codec.ProtocolEvent

Known Direct Subclasses

io.netty5.handler.codec.http.websocketx.WebSocketServerHandshakeCompletionEvent, io.netty5.handler.codec.http.websocketx.WebSocketClientHandshakeCompletionEvent

Imports

io.netty5.handler.codec.ProtocolEvent

ProtocolEvent that indicate the completion of a websocket handshake.

Field Summary

Modifier and Type	Field and Description
private final Throwable	cause
private final WebSocketVersion	version

Constructor Summary

Access	Constructor and Description
pack-priv	WebSocketHandshakeCompletionEvent(WebSocketVersion the `WebSocketVersion` that was used. version) Create a new event that indicate a successful websocket handshake.
pack-priv	WebSocketHandshakeCompletionEvent(Throwable the cause of the failure cause) Create a new event that indicate a failed websocket handshake.

Method Summary

Modifier and Type	Method and Description
public final Throwable	cause() Implements io.netty5.handler.codec.ProtocolEvent.cause. Returns the cause of the failure, or `null` if `isSuccess()`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final WebSocketVersion	Returns: the version. version() Return the `WebSocketVersion` of the handshake or `null` in case of a failure.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

cause	back to summary
private final Throwable cause

version	back to summary
private final WebSocketVersion version

Constructor Detail

WebSocketHandshakeCompletionEvent back to summary

WebSocketHandshakeCompletionEvent	back to summary
pack-priv WebSocketHandshakeCompletionEvent(WebSocketVersion version) Create a new event that indicate a successful websocket handshake. Parameters version:WebSocketVersion the `WebSocketVersion` that was used.

pack-priv WebSocketHandshakeCompletionEvent(WebSocketVersion version)

Create a new event that indicate a successful websocket handshake.

Parameters

version:WebSocketVersion: the WebSocketVersion that was used.

WebSocketHandshakeCompletionEvent	back to summary
pack-priv WebSocketHandshakeCompletionEvent(Throwable cause) Create a new event that indicate a failed websocket handshake. Parameters cause:Throwable the cause of the failure

WebSocketHandshakeCompletionEvent

back to summary

pack-priv WebSocketHandshakeCompletionEvent(Throwable cause)

Create a new event that indicate a failed websocket handshake.

Parameters

cause:Throwable: the cause of the failure

Method Detail

cause back to summary

cause	back to summary
public final Throwable cause() Implements io.netty5.handler.codec.ProtocolEvent.cause. Doc from io.netty5.handler.codec.ProtocolEvent.cause. Returns the cause of the failure, or `null` if `isSuccess()`. Returns:Throwable the `Throwable` if `isFailed()` or `null` if `isSuccess()`. Annotations @Override

public final Throwable cause()

Implements io.netty5.handler.codec.ProtocolEvent.cause.

Doc from io.netty5.handler.codec.ProtocolEvent.cause.

Returns the cause of the failure, or null if isSuccess().

Returns:Throwable

the Throwable if isFailed() or null if isSuccess().

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

version back to summary

version	back to summary
public final WebSocketVersion version() Return the `WebSocketVersion` of the handshake or `null` in case of a failure. Returns:WebSocketVersion the version.

public final WebSocketVersion version()

Return the WebSocketVersion of the handshake or null in case of a failure.

Returns:WebSocketVersion: the version.