com.sun.grizzly.websockets
Class WebSocketOutputFilter

java.lang.Object
  extended by com.sun.grizzly.websockets.WebSocketOutputFilter
All Implemented Interfaces:
OutputFilter, OutputBuffer

public class WebSocketOutputFilter
extends Object
implements OutputFilter


Constructor Summary
WebSocketOutputFilter()
           
 
Method Summary
 int doWrite(ByteChunk chunk, Response unused)
          Write some bytes.
 long end()
          End the current request.
 ByteChunk getEncodingName()
          Get the name of the encoding handled by this filter.
 void recycle()
          Make the filter ready to process the next request.
 void setBuffer(OutputBuffer buffer)
          Set the next buffer in the filter pipeline.
 void setResponse(Response response)
          Some filters need additional parameters from the response.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebSocketOutputFilter

public WebSocketOutputFilter()
Method Detail

doWrite

public int doWrite(ByteChunk chunk,
                   Response unused)
            throws IOException
Description copied from interface: OutputFilter
Write some bytes.

Specified by:
doWrite in interface OutputFilter
Specified by:
doWrite in interface OutputBuffer
Parameters:
chunk - Data to write
unused - Used to allow buffers that can be shared by multiple responses.
Returns:
number of bytes written by the filter
Throws:
IOException

setResponse

public void setResponse(Response response)
Description copied from interface: OutputFilter
Some filters need additional parameters from the response. All the necessary reading can occur in that method, as this method is called after the response header processing is complete.

Specified by:
setResponse in interface OutputFilter

recycle

public void recycle()
Description copied from interface: OutputFilter
Make the filter ready to process the next request.

Specified by:
recycle in interface OutputFilter

getEncodingName

public ByteChunk getEncodingName()
Description copied from interface: OutputFilter
Get the name of the encoding handled by this filter.

Specified by:
getEncodingName in interface OutputFilter

setBuffer

public void setBuffer(OutputBuffer buffer)
Description copied from interface: OutputFilter
Set the next buffer in the filter pipeline.

Specified by:
setBuffer in interface OutputFilter

end

public long end()
         throws IOException
Description copied from interface: OutputFilter
End the current request. It is acceptable to write extra bytes using buffer.doWrite during the execution of this method.

Specified by:
end in interface OutputFilter
Returns:
Should return 0 unless the filter does some content length delimitation, in which case the number is the amount of extra bytes or missing bytes, which would indicate an error. Note: It is recommended that extra bytes be swallowed by the filter.
Throws:
IOException


Copyright © 2012 Oracle Corporation. All Rights Reserved.