WebSocketRequestImpl (smart-http-server 1.4.1 API)

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

所有已实现的接口:

WebSocket, Reset, HttpRequest, WebSocketRequest
```
public class WebSocketRequestImpl
extends Object
implements WebSocketRequest, WebSocket
```
版本:

V1.0 , 2018/8/31

作者:

三刀

字段概要
- 从接口继承的字段 org.smartboot.http.common.codec.websocket.WebSocket
  PAYLOAD_FINISH

构造器概要

构造器
构造器和说明

WebSocketRequestImpl(Request baseHttpRequest)

构造器
构造器和说明
`WebSocketRequestImpl(Request baseHttpRequest)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`org.smartboot.socket.util.Attachment`	`getAttachment()` 获取附件对象
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`Cookie[]`	`getCookies()` 获取Cookie
`int`	`getFrameOpcode()`
`int`	`getFrameRsv()`
`String`	`getHeader(String headName)` 获取指定名称的Http Header值
`Collection<String>`	`getHeaderNames()`
`Collection<String>`	`getHeaders(String name)`
`InputStream`	`getInputStream()`
`InetSocketAddress`	`getLocalAddress()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`byte[]`	`getMaskingKey()`
`String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameters()`
`String[]`	`getParameterValues(String name)`
`byte[]`	`getPayload()`
`SmartDecoder`	`getPayloadDecoder()`
`long`	`getPayloadLength()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`InetSocketAddress`	`getRemoteAddress()`
`String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`Request`	`getRequest()`
`String`	`getRequestURI()`
`String`	`getRequestURL()`
`WebSocketResponseImpl`	`getResponse()`
`String`	`getScheme()`
`boolean`	`isFrameFinalFlag()`
`boolean`	`isFrameMasked()`
`boolean`	`isSecure()` 是否启动安全通信
`void`	`reset()`
`void`	`setAttachment(org.smartboot.socket.util.Attachment attachment)` 存放附件，支持任意类型
`void`	`setFrameFinalFlag(boolean frameFinalFlag)`
`void`	`setFrameMasked(boolean frameMasked)`
`void`	`setFrameOpcode(int frameOpcode)`
`void`	`setFrameRsv(int frameRsv)`
`void`	`setMaskingKey(byte[] maskingKey)`
`void`	`setPayload(byte[] payload)`
`void`	`setPayloadDecoder(SmartDecoder payloadDecoder)`
`void`	`setPayloadLength(long payloadLength)`

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

从接口继承的方法 org.smartboot.http.server.WebSocketRequest
getLocalAddress, getParameters, getQueryString, getRemoteAddress, getRequestURI, getRequestURL, isSecure

- 构造器详细资料
  - WebSocketRequestImpl
```
public WebSocketRequestImpl(Request baseHttpRequest)
```
- 方法详细资料
  - getResponse
```
public final WebSocketResponseImpl getResponse()
```
  - getInputStream
```
public InputStream getInputStream()
```
    指定者:
    
    getInputStream 在接口中 HttpRequest
  - reset
```
public void reset()
```
    指定者:
    
    reset 在接口中 Reset
  - isFrameFinalFlag
```
public boolean isFrameFinalFlag()
```
    指定者:
    
    isFrameFinalFlag 在接口中 WebSocket
  - setFrameFinalFlag
```
public void setFrameFinalFlag(boolean frameFinalFlag)
```
    指定者:
    
    setFrameFinalFlag 在接口中 WebSocket
  - isFrameMasked
```
public boolean isFrameMasked()
```
    指定者:
    
    isFrameMasked 在接口中 WebSocket
  - setFrameMasked
```
public void setFrameMasked(boolean frameMasked)
```
    指定者:
    
    setFrameMasked 在接口中 WebSocket
  - getFrameRsv
```
public int getFrameRsv()
```
    指定者:
    
    getFrameRsv 在接口中 WebSocket
  - setFrameRsv
```
public void setFrameRsv(int frameRsv)
```
    指定者:
    
    setFrameRsv 在接口中 WebSocket
  - getFrameOpcode
```
public int getFrameOpcode()
```
    指定者:
    
    getFrameOpcode 在接口中 WebSocket
    
    指定者:
    
    getFrameOpcode 在接口中 WebSocketRequest
  - setFrameOpcode
```
public void setFrameOpcode(int frameOpcode)
```
    指定者:
    
    setFrameOpcode 在接口中 WebSocket
  - getPayload
```
public byte[] getPayload()
```
    指定者:
    
    getPayload 在接口中 WebSocket
    
    指定者:
    
    getPayload 在接口中 WebSocketRequest
  - getPayloadLength
```
public long getPayloadLength()
```
    指定者:
    
    getPayloadLength 在接口中 WebSocket
  - setPayloadLength
```
public void setPayloadLength(long payloadLength)
```
    指定者:
    
    setPayloadLength 在接口中 WebSocket
  - getMaskingKey
```
public byte[] getMaskingKey()
```
    指定者:
    
    getMaskingKey 在接口中 WebSocket
  - setMaskingKey
```
public void setMaskingKey(byte[] maskingKey)
```
    指定者:
    
    setMaskingKey 在接口中 WebSocket
  - setPayload
```
public void setPayload(byte[] payload)
```
    指定者:
    
    setPayload 在接口中 WebSocket
  - getPayloadDecoder
```
public SmartDecoder getPayloadDecoder()
```
    指定者:
    
    getPayloadDecoder 在接口中 WebSocket
  - setPayloadDecoder
```
public void setPayloadDecoder(SmartDecoder payloadDecoder)
```
    指定者:
    
    setPayloadDecoder 在接口中 WebSocket
  - getHeader
```
public final String getHeader(String headName)
```
    从接口复制的说明: HttpRequest
    
    获取指定名称的Http Header值
    
    指定者:
    
    getHeader 在接口中 HttpRequest
    
    返回:
  - getHeaders
```
public final Collection<String> getHeaders(String name)
```
    指定者:
    
    getHeaders 在接口中 HttpRequest
  - getHeaderNames
```
public final Collection<String> getHeaderNames()
```
    指定者:
    
    getHeaderNames 在接口中 HttpRequest
  - getRequestURI
```
public final String getRequestURI()
```
    指定者:
    
    getRequestURI 在接口中 HttpRequest
  - getProtocol
```
public final String getProtocol()
```
    指定者:
    
    getProtocol 在接口中 HttpRequest
  - getMethod
```
public final String getMethod()
```
    从接口复制的说明: HttpRequest
    
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
    
    指定者:
    
    getMethod 在接口中 HttpRequest
    
    返回:
    
    a String specifying the name of the method with which this request was made
  - getScheme
```
public final String getScheme()
```
    指定者:
    
    getScheme 在接口中 HttpRequest
  - getRequestURL
```
public final String getRequestURL()
```
    指定者:
    
    getRequestURL 在接口中 HttpRequest
  - getQueryString
```
public final String getQueryString()
```
    指定者:
    
    getQueryString 在接口中 HttpRequest
  - getContentType
```
public final String getContentType()
```
    指定者:
    
    getContentType 在接口中 HttpRequest
  - getContentLength
```
public final int getContentLength()
```
    指定者:
    
    getContentLength 在接口中 HttpRequest
  - getParameter
```
public final String getParameter(String name)
```
    指定者:
    
    getParameter 在接口中 HttpRequest
  - getParameters
```
public final Map<String,String[]> getParameters()
```
    指定者:
    
    getParameters 在接口中 HttpRequest
  - getParameterValues
```
public final String[] getParameterValues(String name)
```
    指定者:
    
    getParameterValues 在接口中 HttpRequest
  - getRemoteAddr
```
public final String getRemoteAddr()
```
    从接口复制的说明: HttpRequest
    
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
    
    指定者:
    
    getRemoteAddr 在接口中 HttpRequest
    
    返回:
    
    a String containing the IP address of the client that sent the request
  - getRemoteAddress
```
public final InetSocketAddress getRemoteAddress()
```
    指定者:
    
    getRemoteAddress 在接口中 HttpRequest
  - getLocalAddress
```
public final InetSocketAddress getLocalAddress()
```
    指定者:
    
    getLocalAddress 在接口中 HttpRequest
  - getRemoteHost
```
public final String getRemoteHost()
```
    从接口复制的说明: HttpRequest
    
    Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
    
    指定者:
    
    getRemoteHost 在接口中 HttpRequest
    
    返回:
    
    a String containing the fully qualified name of the client
  - getLocale
```
public final Locale getLocale()
```
    指定者:
    
    getLocale 在接口中 HttpRequest
  - getLocales
```
public final Enumeration<Locale> getLocales()
```
    指定者:
    
    getLocales 在接口中 HttpRequest
  - getCharacterEncoding
```
public final String getCharacterEncoding()
```
    指定者:
    
    getCharacterEncoding 在接口中 HttpRequest
  - getRequest
```
public final Request getRequest()
```
  - getCookies
```
public Cookie[] getCookies()
```
    从接口复制的说明: HttpRequest
    
    获取Cookie
    
    指定者:
    
    getCookies 在接口中 HttpRequest
  - getAttachment
```
public org.smartboot.socket.util.Attachment getAttachment()
```
    从接口复制的说明: HttpRequest
    
    获取附件对象
    
    指定者:
    
    getAttachment 在接口中 HttpRequest
    
    返回:
    
    附件
  - setAttachment
```
public void setAttachment(org.smartboot.socket.util.Attachment attachment)
```
    从接口复制的说明: HttpRequest
    
    存放附件，支持任意类型
    
    指定者:
    
    setAttachment 在接口中 HttpRequest
    
    参数:
    
    attachment - 附件对象
  - isSecure
```
public final boolean isSecure()
```
    从接口复制的说明: HttpRequest
    
    是否启动安全通信
    
    指定者:
    
    isSecure 在接口中 HttpRequest

类 WebSocketRequestImpl

字段概要

从接口继承的字段 org.smartboot.http.common.codec.websocket.WebSocket

构造器概要

方法概要

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

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

构造器详细资料

WebSocketRequestImpl

方法详细资料

getResponse

getInputStream

reset

isFrameFinalFlag

setFrameFinalFlag

isFrameMasked

setFrameMasked

getFrameRsv

setFrameRsv

getFrameOpcode

setFrameOpcode

getPayload

getPayloadLength

setPayloadLength

getMaskingKey

setMaskingKey

setPayload

getPayloadDecoder

setPayloadDecoder

getHeader

getHeaders

getHeaderNames

getRequestURI

getProtocol

getMethod

getScheme

getRequestURL

getQueryString

getContentType

getContentLength

getParameter

getParameters

getParameterValues

getRemoteAddr

getRemoteAddress

getLocalAddress

getRemoteHost

getLocale

getLocales

getCharacterEncoding

getRequest

getCookies

getAttachment

setAttachment

isSecure