Package org.eclipse.jetty.websocket.api

Class CloseStatus

java.lang.Object

org.eclipse.jetty.websocket.api.CloseStatus

public class CloseStatus
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_REASON_PHRASE

Constructor Summary

Constructors

Constructor	Description
CloseStatus(int closeCode, java.lang.String reasonPhrase)	Creates a reason for closing a web socket connection with the given code and reason phrase.

Method Summary

Modifier and Type	Method	Description
int	getCode()
java.lang.String	getPhrase()
static java.lang.String	trimMaxReasonLength(java.lang.String reason)	Deprecated. use of this method is strongly discouraged, as it creates too many new objects that are just thrown away to accomplish its goals.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REASON_PHRASE

public static final int MAX_REASON_PHRASE

See Also:

Constant Field Values

Constructor Detail

CloseStatus

public CloseStatus(int closeCode,
                   java.lang.String reasonPhrase)

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

Parameters:

closeCode - the close code

reasonPhrase - the reason phrase

See Also:

StatusCode

Method Detail

trimMaxReasonLength

@Deprecated
public static java.lang.String trimMaxReasonLength(java.lang.String reason)

Deprecated.

use of this method is strongly discouraged, as it creates too many new objects that are just thrown away to accomplish its goals.

Convenience method for trimming a long reason phrase at the maximum reason phrase length of 123 UTF-8 bytes (per WebSocket spec).

Parameters:

reason - the proposed reason phrase

Returns:

the reason phrase (trimmed if needed)

getCode

public int getCode()

getPhrase

public java.lang.String getPhrase()