javax.net.websocket

Class CloseReason

java.lang.Object

javax.net.websocket.CloseReason

public class CloseReason
extends Object

A class encapsulating the reason why a web socket has been closed, or why it is being asked to close. Note the acceptable uses of codes and reason phrase defined in FRC 6455.

Since:

DRAFT 001

Author:

dannycoward

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CloseReason.CloseCode A marker interface for the close codes.
static class	CloseReason.CloseCodes An Enumeration of status codes for a web socket close that are defined in the specification.

Constructor Summary

Constructors

Constructor and Description
CloseReason(CloseReason.CloseCode closeCode, String reasonPhrase) Creates a reason for closing a web socket connection with the given code and reason phrase.

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseReason

public CloseReason(CloseReason.CloseCode closeCode,
           String reasonPhrase)

Creates a reason for closing a web socket connection with the given code and reason phrase.

Parameters:

closeCode -

reasonPhrase -