CloseFrame

java.lang.Object
- org.java_websocket.framing.FramedataImpl1
- - org.java_websocket.framing.ControlFrame
  - - org.java_websocket.framing.CloseFrame

所有已实现的接口:

Framedata
```
public class CloseFrame
extends ControlFrame
```
Class to represent a close frame

嵌套类概要
- 从接口继承的嵌套类/接口 org.java_websocket.framing.Framedata
  Framedata.Opcode

字段概要

字段
限定符和类型	字段和说明
`static int`	`ABNORMAL_CLOSE` 1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
`static int`	`BUGGYCLOSE` The connection had a buggy close (this should not happen)
`static int`	`EXTENSION` 1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.
`static int`	`FLASHPOLICY` The connection was flushed and closed
`static int`	`GOING_AWAY` 1001 indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.
`static int`	`NEVER_CONNECTED` The connection had never been established
`static int`	`NO_UTF8` 1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).
`static int`	`NOCODE` 1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
`static int`	`NORMAL` indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.
`static int`	`POLICY_VALIDATION` 1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
`static int`	`PROTOCOL_ERROR` 1002 indicates that an endpoint is terminating the connection due to a protocol error.
`static int`	`REFUSE` 1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g. an endpoint that understands only text data MAY send this if it receives a binary message).
`static int`	`TLS_ERROR` 1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint.
`static int`	`TOOBIG` 1009 indicates that an endpoint is terminating the connection because it has received a message which is too big for it to process.
`static int`	`UNEXPECTED_CONDITION` 1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

构造器概要

构造器
构造器和说明

CloseFrame()
Constructor for a close frame Using opcode closing and fin = true

构造器
构造器和说明
`CloseFrame()` Constructor for a close frame Using opcode closing and fin = true

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`getCloseCode()` Get the used close code
`java.lang.String`	`getMessage()` Get the message that closeframe is containing
`java.nio.ByteBuffer`	`getPayloadData()` The "Payload data" which was sent in this frame
`void`	`isValid()` Check if the frame is valid due to specification
`void`	`setCode(int code)` Set the close code for this close frame
`void`	`setPayload(java.nio.ByteBuffer payload)` Set the payload of this frame to the provided payload
`void`	`setReason(java.lang.String reason)` Set the close reason for this close frame
`java.lang.String`	`toString()`

从类继承的方法 org.java_websocket.framing.FramedataImpl1
append, get, getOpcode, getTransfereMasked, isFin, isRSV1, isRSV2, isRSV3, setFin, setRSV1, setRSV2, setRSV3, setTransferemasked

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - NORMAL
```
public static final int NORMAL
```
    indicates a normal closure, meaning whatever purpose the connection was established for has been fulfilled.
    
    另请参阅:
    
    常量字段值
  - GOING_AWAY
```
public static final int GOING_AWAY
```
    1001 indicates that an endpoint is "going away", such as a server going down, or a browser having navigated away from a page.
    
    另请参阅:
    
    常量字段值
  - PROTOCOL_ERROR
```
public static final int PROTOCOL_ERROR
```
    1002 indicates that an endpoint is terminating the connection due to a protocol error.
    
    另请参阅:
    
    常量字段值
  - REFUSE
```
public static final int REFUSE
```
    1003 indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g. an endpoint that understands only text data MAY send this if it receives a binary message).
    
    另请参阅:
    
    常量字段值
  - NOCODE
```
public static final int NOCODE
```
    1005 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that no status code was actually present.
    
    另请参阅:
    
    常量字段值
  - ABNORMAL_CLOSE
```
public static final int ABNORMAL_CLOSE
```
    1006 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g. without sending or receiving a Close control frame.
    
    另请参阅:
    
    常量字段值
  - NO_UTF8
```
public static final int NO_UTF8
```
    1007 indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [RFC3629] data within a text message).
    
    另请参阅:
    
    常量字段值
  - POLICY_VALIDATION
```
public static final int POLICY_VALIDATION
```
    1008 indicates that an endpoint is terminating the connection because it has received a message that violates its policy. This is a generic status code that can be returned when there is no other more suitable status code (e.g. 1003 or 1009), or if there is a need to hide specific details about the policy.
    
    另请参阅:
    
    常量字段值
  - TOOBIG
```
public static final int TOOBIG
```
    1009 indicates that an endpoint is terminating the connection because it has received a message which is too big for it to process.
    
    另请参阅:
    
    常量字段值
  - EXTENSION
```
public static final int EXTENSION
```
    1010 indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. The list of extensions which are needed SHOULD appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.
    
    另请参阅:
    
    常量字段值
  - UNEXPECTED_CONDITION
```
public static final int UNEXPECTED_CONDITION
```
    1011 indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
    
    另请参阅:
    
    常量字段值
  - TLS_ERROR
```
public static final int TLS_ERROR
```
    1015 is a reserved value and MUST NOT be set as a status code in a Close control frame by an endpoint. It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
    
    另请参阅:
    
    常量字段值
  - NEVER_CONNECTED
```
public static final int NEVER_CONNECTED
```
    The connection had never been established
    
    另请参阅:
    
    常量字段值
  - BUGGYCLOSE
```
public static final int BUGGYCLOSE
```
    The connection had a buggy close (this should not happen)
    
    另请参阅:
    
    常量字段值
  - FLASHPOLICY
```
public static final int FLASHPOLICY
```
    The connection was flushed and closed
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - CloseFrame
```
public CloseFrame()
```
    Constructor for a close frame
    Using opcode closing and fin = true
- 方法详细资料
  - setCode
```
public void setCode(int code)
```
    Set the close code for this close frame
    
    参数:
    
    code - the close code
  - setReason
```
public void setReason(java.lang.String reason)
```
    Set the close reason for this close frame
    
    参数:
    
    reason - the reason code
  - getCloseCode
```
public int getCloseCode()
```
    Get the used close code
    
    返回:
    
    the used close code
  - getMessage
```
public java.lang.String getMessage()
```
    Get the message that closeframe is containing
    
    返回:
    
    the message in this frame
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 FramedataImpl1
  - isValid
```
public void isValid()
             throws InvalidDataException
```
    从类复制的说明: FramedataImpl1
    
    Check if the frame is valid due to specification
    
    覆盖:
    
    isValid 在类中 ControlFrame
    
    抛出:
    
    InvalidDataException - thrown if the frame is not a valid frame
  - setPayload
```
public void setPayload(java.nio.ByteBuffer payload)
```
    从类复制的说明: FramedataImpl1
    
    Set the payload of this frame to the provided payload
    
    覆盖:
    
    setPayload 在类中 FramedataImpl1
    
    参数:
    
    payload - the payload which is to set
  - getPayloadData
```
public java.nio.ByteBuffer getPayloadData()
```
    从接口复制的说明: Framedata
    
    The "Payload data" which was sent in this frame
    
    指定者:
    
    getPayloadData 在接口中 Framedata
    
    覆盖:
    
    getPayloadData 在类中 FramedataImpl1
    
    返回:
    
    the "Payload data" as ByteBuffer

类 CloseFrame

嵌套类概要

从接口继承的嵌套类/接口 org.java_websocket.framing.Framedata

字段概要

构造器概要

方法概要

从类继承的方法 org.java_websocket.framing.FramedataImpl1

从类继承的方法 java.lang.Object

字段详细资料

NORMAL

GOING_AWAY

PROTOCOL_ERROR

REFUSE

NOCODE

ABNORMAL_CLOSE

NO_UTF8

POLICY_VALIDATION

TOOBIG

EXTENSION

UNEXPECTED_CONDITION

TLS_ERROR

NEVER_CONNECTED

BUGGYCLOSE

FLASHPOLICY

构造器详细资料

CloseFrame

方法详细资料

setCode

setReason

getCloseCode

getMessage

toString

isValid

setPayload

getPayloadData