Package org.apache.tomcat.websocket
Class PerMessageDeflate
java.lang.Object
org.apache.tomcat.websocket.PerMessageDeflate
- All Implemented Interfaces:
- Transformation
- 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()Clean-up any resources that were used by the transformation.Obtain the extension that describes the information to be returned to the client.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> uncompressedParts) 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.voidSets the next transformation in the pipeline.booleanvalidateRsv(int rsv, byte opCode) Validates the RSV and opcode combination (assumed to have been extracted from a WebSocket Frame) for this extension.booleanvalidateRsvBits(int i) Validate that the RSV bit(s) required by this transformation are not being used by another extension.
- 
Field Details- 
NAME- See Also:
 
 
- 
- 
Method Details- 
getMoreDatapublic TransformationResult getMoreData(byte opCode, boolean fin, int rsv, ByteBuffer dest) throws IOException Description copied from interface:TransformationObtain more input data.- Specified by:
- getMoreDatain interface- Transformation
- Parameters:
- opCode- The opcode for the frame currently being processed
- fin- Is this the final frame in this WebSocket message?
- rsv- The reserved bits for the frame currently being processed
- dest- The buffer in which the data is to be written
- Returns:
- The result of trying to read more data from the transform
- Throws:
- IOException- If an I/O error occurs while reading data from the transform
 
- 
validateRsvpublic boolean validateRsv(int rsv, byte opCode) Description copied from interface:TransformationValidates the RSV and opcode combination (assumed to have been extracted from a WebSocket Frame) for this extension. The implementation is expected to unset any RSV bits it has validated before passing the remaining RSV bits to the next transformation in the pipeline.- Specified by:
- validateRsvin interface- Transformation
- Parameters:
- rsv- The RSV bits received as an int in the range zero to seven with RSV1 as the MSB and RSV3 as the LSB
- opCode- The opCode received
- Returns:
- trueif the RSV is valid otherwise- false
 
- 
getExtensionResponseDescription copied from interface:TransformationObtain the extension that describes the information to be returned to the client.- Specified by:
- getExtensionResponsein interface- Transformation
- Returns:
- The extension information that describes the parameters that have been agreed for this transformation
 
- 
setNextDescription copied from interface:TransformationSets the next transformation in the pipeline.- Specified by:
- setNextin interface- Transformation
- Parameters:
- t- The next transformation
 
- 
validateRsvBitspublic boolean validateRsvBits(int i) Description copied from interface:TransformationValidate that the RSV bit(s) required by this transformation are not being used by another extension. The implementation is expected to set any bits it requires before passing the set of in-use bits to the next transformation.- Specified by:
- validateRsvBitsin interface- Transformation
- Parameters:
- 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 LSB
- Returns:
- trueif the combination of RSV bits used by the transformations in the pipeline do not conflict otherwise- false
 
- 
sendMessagePartpublic List<org.apache.tomcat.websocket.MessagePart> sendMessagePart(List<org.apache.tomcat.websocket.MessagePart> uncompressedParts) throws IOException Description copied from interface:TransformationTakes 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.- Specified by:
- sendMessagePartin interface- Transformation
- Parameters:
- uncompressedParts- The list of messages to be transformed
- Returns:
- The list of messages after this any any subsequent transformations have been applied. The size of the returned list may be bigger or smaller than the size of the input list
- Throws:
- IOException- If an error occurs during the transformation of the message parts
 
- 
closepublic void close()Description copied from interface:TransformationClean-up any resources that were used by the transformation.- Specified by:
- closein interface- Transformation
 
 
-