WebSocketResponseImpl (smart-http-server 1.4.1 API)

java.lang.Object
- org.smartboot.http.server.impl.WebSocketResponseImpl

所有已实现的接口:

Reset, HttpResponse, WebSocketResponse
```
public class WebSocketResponseImpl
extends Object
implements WebSocketResponse
```
版本:

V1.0 , 2018/2/3

作者:

三刀

构造器概要

构造器
构造器和说明

WebSocketResponseImpl(WebSocketRequestImpl webSocketRequest)

构造器
构造器和说明
`WebSocketResponseImpl(WebSocketRequestImpl webSocketRequest)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addCookie(Cookie cookie)` 添加Cookie信息
`void`	`addHeader(String name, String value)` Adds a response header with the given name and value.
`void`	`close()` 关闭ws通道
`void`	`close(int code, String reason)`
`void`	`flush()` 输出数据
`int`	`getContentLength()`
`String`	`getContentType()`
`List<Cookie>`	`getCookies()`
`String`	`getHeader(String name)`
`Collection<String>`	`getHeaderNames()` Get the header names set for this HTTP response.
`Collection<String>`	`getHeaders(String name)` Return a Collection of all the header values associated with the specified header name.
`int`	`getHttpStatus()` 获取Http响应状态
`org.smartboot.http.server.impl.AbstractOutputStream`	`getOutputStream()` 响应消息输出流
`String`	`getReasonPhrase()` 获取Http响应描述
`boolean`	`isClosed()` 是否要断开TCP连接
`boolean`	`isDefaultStatus()`
`void`	`ping(byte[] bytes)`
`void`	`pong(byte[] bytes)`
`void`	`reset()`
`void`	`sendBinaryMessage(byte[] bytes)` 发送二进制响应
`void`	`sendBinaryMessage(byte[] bytes, int offset, int length)` 发送二进制响应
`void`	`sendTextMessage(String text)` 发送文本响应
`void`	`setContentLength(int contentLength)`
`void`	`setContentType(String contentType)`
`void`	`setHeader(String name, String value)` Sets a response header with the given name and value.
`void`	`setHttpStatus(HttpStatus httpStatus)` 设置Http响应状态,若不设置默认`HttpStatus.OK`
`void`	`setHttpStatus(int value, String reasonPhrase)` 设置Http响应状态,若不设置默认`HttpStatus.OK`
`void`	`write(byte[] buffer)`

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

从接口继承的方法 org.smartboot.http.server.WebSocketResponse
ping, pong

- 构造器详细资料
  - WebSocketResponseImpl
```
public WebSocketResponseImpl(WebSocketRequestImpl webSocketRequest)
```
- 方法详细资料
  - sendTextMessage
```
public void sendTextMessage(String text)
```
    从接口复制的说明: WebSocketResponse
    
    发送文本响应
    
    指定者:
    
    sendTextMessage 在接口中 WebSocketResponse
  - sendBinaryMessage
```
public void sendBinaryMessage(byte[] bytes)
```
    从接口复制的说明: WebSocketResponse
    
    发送二进制响应
    
    指定者:
    
    sendBinaryMessage 在接口中 WebSocketResponse
  - sendBinaryMessage
```
public void sendBinaryMessage(byte[] bytes,
                              int offset,
                              int length)
```
    从接口复制的说明: WebSocketResponse
    
    发送二进制响应
    
    指定者:
    
    sendBinaryMessage 在接口中 WebSocketResponse
  - pong
```
public void pong(byte[] bytes)
```
    指定者:
    
    pong 在接口中 WebSocketResponse
  - close
```
public void close()
```
    从接口复制的说明: WebSocketResponse
    
    关闭ws通道
    
    指定者:
    
    close 在接口中 HttpResponse
    
    指定者:
    
    close 在接口中 WebSocketResponse
  - close
```
public void close(int code,
                  String reason)
```
    指定者:
    
    close 在接口中 WebSocketResponse
  - ping
```
public void ping(byte[] bytes)
```
    指定者:
    
    ping 在接口中 WebSocketResponse
  - flush
```
public void flush()
```
    从接口复制的说明: WebSocketResponse
    
    输出数据
    
    指定者:
    
    flush 在接口中 WebSocketResponse
  - reset
```
public final void reset()
```
    指定者:
    
    reset 在接口中 Reset
  - getOutputStream
```
public final org.smartboot.http.server.impl.AbstractOutputStream getOutputStream()
```
    从接口复制的说明: HttpResponse
    
    响应消息输出流
    
    指定者:
    
    getOutputStream 在接口中 HttpResponse
    
    返回:
  - getHttpStatus
```
public int getHttpStatus()
```
    从接口复制的说明: HttpResponse
    
    获取Http响应状态
    
    指定者:
    
    getHttpStatus 在接口中 HttpResponse
    
    返回:
  - setHttpStatus
```
public final void setHttpStatus(HttpStatus httpStatus)
```
    从接口复制的说明: HttpResponse
    
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    指定者:
    
    setHttpStatus 在接口中 HttpResponse
  - getReasonPhrase
```
public String getReasonPhrase()
```
    从接口复制的说明: HttpResponse
    
    获取Http响应描述
    
    指定者:
    
    getReasonPhrase 在接口中 HttpResponse
    
    返回:
  - setHttpStatus
```
public final void setHttpStatus(int value,
                                String reasonPhrase)
```
    从接口复制的说明: HttpResponse
    
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    指定者:
    
    setHttpStatus 在接口中 HttpResponse
  - isDefaultStatus
```
public boolean isDefaultStatus()
```
  - setHeader
```
public final void setHeader(String name,
                            String value)
```
    从接口复制的说明: HttpResponse
    
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
    
    指定者:
    
    setHeader 在接口中 HttpResponse
    
    参数:
    
    name - the name of the header
    
    value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    另请参阅:
    
    HttpResponse.addHeader(java.lang.String, java.lang.String)
  - addHeader
```
public final void addHeader(String name,
                            String value)
```
    从接口复制的说明: HttpResponse
    
    Adds a response header with the given name and value. This method allows response headers to have multiple values.
    
    指定者:
    
    addHeader 在接口中 HttpResponse
    
    参数:
    
    name - the name of the header
    
    value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    另请参阅:
    
    HttpResponse.setHeader(java.lang.String, java.lang.String)
  - getHeader
```
public final String getHeader(String name)
```
    指定者:
    
    getHeader 在接口中 HttpResponse
  - getHeaders
```
public final Collection<String> getHeaders(String name)
```
    从接口复制的说明: HttpResponse
    
    Return a Collection of all the header values associated with the specified header name.
    
    指定者:
    
    getHeaders 在接口中 HttpResponse
    
    参数:
    
    name - Header name to look up
    
    返回:
    
    The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.
  - getHeaderNames
```
public final Collection<String> getHeaderNames()
```
    从接口复制的说明: HttpResponse
    
    Get the header names set for this HTTP response.
    
    指定者:
    
    getHeaderNames 在接口中 HttpResponse
    
    返回:
    
    The header names set for this HTTP response.
  - write
```
public final void write(byte[] buffer)
                 throws IOException
```
    指定者:
    
    write 在接口中 HttpResponse
    
    抛出:
    
    IOException
  - getCookies
```
public List<Cookie> getCookies()
```
  - addCookie
```
public void addCookie(Cookie cookie)
```
    从接口复制的说明: HttpResponse
    
    添加Cookie信息
    
    指定者:
    
    addCookie 在接口中 HttpResponse
  - getContentLength
```
public int getContentLength()
```
    指定者:
    
    getContentLength 在接口中 HttpResponse
  - setContentLength
```
public void setContentLength(int contentLength)
```
    指定者:
    
    setContentLength 在接口中 HttpResponse
  - getContentType
```
public final String getContentType()
```
    指定者:
    
    getContentType 在接口中 HttpResponse
  - setContentType
```
public final void setContentType(String contentType)
```
    指定者:
    
    setContentType 在接口中 HttpResponse
  - isClosed
```
public final boolean isClosed()
```
    是否要断开TCP连接
    
    返回:
    
    true/false

类 WebSocketResponseImpl

构造器概要

方法概要

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

从接口继承的方法 org.smartboot.http.server.WebSocketResponse

构造器详细资料

WebSocketResponseImpl

方法详细资料

sendTextMessage

sendBinaryMessage

sendBinaryMessage

pong

close

close

ping

flush

reset

getOutputStream

getHttpStatus

setHttpStatus

getReasonPhrase

setHttpStatus

isDefaultStatus

setHeader

addHeader

getHeader

getHeaders

getHeaderNames

write

getCookies

addCookie

getContentLength

setContentLength

getContentType

setContentType

isClosed