bayou.websocket

Class WebSocketClose

java.lang.Object

java.lang.Throwable

java.lang.Exception

bayou.util.End

bayou.websocket.WebSocketClose

All Implemented Interfaces:

Serializable

public class WebSocketClose
extends End

To indicate that a WebSocket inbound is gracefully closed.

This is a control exception, a subtype of End. It's used by WebSocketChannel.readMessage().

Close-Frame is sent by a WebSocket endpoint to gracefully close its outbound direction, see RFC6455 §5.5.1. The Close-Frame may contain code and reason for diagnosis.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WebSocketClose(int code, String reason) Create a WebSocketClose instance.

Method Summary

Instance Methods
int	code() The code given by the Close-Frame.
String	reason() The reason given by the Close-Frame.

Methods inherited from class bayou.util.End

async, instance

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClose

public WebSocketClose(int code,
                      String reason)

Create a WebSocketClose instance.

Method Detail

code

public int code()

The code given by the Close-Frame. If the Close-Frame contains no code, 1005 is the substitute value.

See RFC6455 §7.4.

reason

public String reason()

The reason given by the Close-Frame. If the Close-Frame contains no reason, "" is the substitute value.