public interface Transformation
Modifier and Type | Method and Description |
---|---|
void |
close()
Clean-up any resources that were used by the transformation.
|
Extension |
getExtensionResponse()
Obtain the extension that describes the information to be returned to the
client.
|
TransformationResult |
getMoreData(byte opCode,
boolean fin,
int rsv,
ByteBuffer dest)
Obtain more input data.
|
List<org.apache.tomcat.websocket.MessagePart> |
sendMessagePart(List<org.apache.tomcat.websocket.MessagePart> messageParts)
Takes the provided list of messages, transforms them, passes the
transformed list on to the next transformation (if any) and then returns
the resulting list of message parts after all of the transformations have
been applied.
|
void |
setNext(Transformation t)
Sets the next transformation in the pipeline.
|
boolean |
validateRsv(int rsv,
byte opCode)
Validates the RSV and opcode combination (assumed to have been extracted
from a WebSocket Frame) for this extension.
|
boolean |
validateRsvBits(int i)
Validate that the RSV bit(s) required by this transformation are not
being used by another extension.
|
void setNext(Transformation t)
t
- The next transformationboolean validateRsvBits(int i)
i
- The RSV bits marked as in use so far as an int in the
range zero to seven with RSV1 as the MSB and RSV3 as the
LSBtrue
if the combination of RSV bits used by the
transformations in the pipeline do not conflict otherwise
false
Extension getExtensionResponse()
TransformationResult getMoreData(byte opCode, boolean fin, int rsv, ByteBuffer dest) throws IOException
opCode
- The opcode for the frame currently being processedfin
- Is this the final frame in this WebSocket message?rsv
- The reserved bits for the frame currently being
processeddest
- The buffer in which the data is to be writtenIOException
- If an I/O error occurs while reading data from the
transformboolean validateRsv(int rsv, byte opCode)
rsv
- The RSV bits received as an int in the range zero to
seven with RSV1 as the MSB and RSV3 as the LSBopCode
- The opCode receivedtrue
if the RSV is valid otherwise
false
List<org.apache.tomcat.websocket.MessagePart> sendMessagePart(List<org.apache.tomcat.websocket.MessagePart> messageParts) throws IOException
messageParts
- The list of messages to be transformedIOException
- If an error occurs during the transformation of the
message partsvoid close()
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.