org.apache.wicket.protocol.ws.api
Class WebSocketResponse

java.lang.Object
  extended by org.apache.wicket.request.Response
      extended by org.apache.wicket.protocol.ws.api.WebSocketResponse

public class WebSocketResponse
extends org.apache.wicket.request.Response

A Response used to cache the written data to the web socket client when Wicket thread locals are available. When the thread locals are not available then you can write directly to the IWebSocketConnection taken from SimpleWebSocketConnectionRegistry. In this case the response wont be cached.

Since:
6.0

Constructor Summary
WebSocketResponse(IWebSocketConnection conn)
           
 
Method Summary
 void close()
           
 String encodeURL(CharSequence url)
           
 IWebSocketConnection getContainerResponse()
           
 void reset()
           
 void write(byte[] array)
           
 void write(byte[] array, int offset, int length)
           
 void write(CharSequence sequence)
           
 
Methods inherited from class org.apache.wicket.request.Response
getOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebSocketResponse

public WebSocketResponse(IWebSocketConnection conn)
Method Detail

write

public void write(CharSequence sequence)
Specified by:
write in class org.apache.wicket.request.Response

write

public void write(byte[] array)
Specified by:
write in class org.apache.wicket.request.Response

write

public void write(byte[] array,
                  int offset,
                  int length)
Specified by:
write in class org.apache.wicket.request.Response

close

public void close()
Overrides:
close in class org.apache.wicket.request.Response

reset

public void reset()
Overrides:
reset in class org.apache.wicket.request.Response

encodeURL

public String encodeURL(CharSequence url)
Specified by:
encodeURL in class org.apache.wicket.request.Response

getContainerResponse

public final IWebSocketConnection getContainerResponse()
Specified by:
getContainerResponse in class org.apache.wicket.request.Response


Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.