WsFrameBase (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.tomcat.websocket.WsFrameBase

Direct Known Subclasses:

WsFrameClient, WsFrameServer
```
public abstract class WsFrameBase
extends java.lang.Object
```
Takes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages. WebSocket Pings received will be responded to automatically without any action required by the application.

Field Summary

Fields
Modifier and Type Field and Description

protected byte[] inputBuffer

protected int writePos

protected WsSession wsSession

Fields
Modifier and Type	Field and Description
`protected byte[]`	`inputBuffer`
`protected int`	`writePos`
`protected WsSession`	`wsSession`

Constructor Summary

Constructors
Constructor and Description

WsFrameBase(WsSession wsSession, Transformation transformation)

Constructors
Constructor and Description
`WsFrameBase(WsSession wsSession, Transformation transformation)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected static long`	`byteArrayToLong(byte[] b, int start, int len)`
`protected abstract Log`	`getLog()`
`protected Transformation`	`getTransformation()`
`protected abstract boolean`	`isMasked()`
`protected boolean`	`isOpen()`
`protected void`	`processInputBuffer()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

wsSession
```
protected final WsSession wsSession
```

inputBuffer
```
protected final byte[] inputBuffer
```

writePos
```
protected volatile int writePos
```

Constructor Detail

WsFrameBase

public WsFrameBase(WsSession wsSession,
           Transformation transformation)

Method Detail

processInputBuffer

protected void processInputBuffer()
                           throws java.io.IOException

Throws:: java.io.IOException

isMasked
```
protected abstract boolean isMasked()
```

getLog
```
protected abstract Log getLog()
```

byteArrayToLong

protected static long byteArrayToLong(byte[] b,
                   int start,
                   int len)
                               throws java.io.IOException

Throws:: java.io.IOException

isOpen
```
protected boolean isOpen()
```

getTransformation

protected Transformation getTransformation()

Class WsFrameBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

wsSession

inputBuffer

writePos

Constructor Detail

WsFrameBase

Method Detail

processInputBuffer

isMasked

getLog

byteArrayToLong

isOpen

getTransformation