Package org.zkoss.zkmax.au.websocket
Class WSAuWriter
- java.lang.Object
-
- org.zkoss.zkmax.au.websocket.WSAuWriter
-
-
Constructor Summary
Constructors Constructor Description WSAuWriter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close(java.lang.Object websocketEndpoint, java.lang.Object response)
Closes the writer and flush the result to client.java.lang.Object
complete()
Indicates the writing has been completed.AuWriter
open(java.lang.Object websocketEndpoint, java.lang.Object response)
Initializes the writer.void
resend(java.lang.Object prevContent)
Resend the content of the previous request returned byAuWriter.complete()
.protected byte[]
restore(java.lang.Object data)
protected java.lang.Object
save(byte[] data)
void
setCompress(boolean compress)
Sets whether to compress the output with GZIP.void
write(java.util.Collection<AuResponse> responses)
Generates a list of responses to the output.void
write(AuResponse response)
Generates the specified the response to the output.void
writeResponseId(int resId)
Generates the response ID to the output.
-
-
-
Method Detail
-
setCompress
public void setCompress(boolean compress)
Description copied from interface:AuWriter
Sets whether to compress the output with GZIP.Default: true.
- Specified by:
setCompress
in interfaceAuWriter
-
open
public AuWriter open(java.lang.Object websocketEndpoint, java.lang.Object response) throws java.io.IOException
Description copied from interface:AuWriter
Initializes the writer.
-
close
public void close(java.lang.Object websocketEndpoint, java.lang.Object response) throws java.io.IOException
Description copied from interface:AuWriter
Closes the writer and flush the result to client.
-
complete
public java.lang.Object complete() throws java.io.IOException
Description copied from interface:AuWriter
Indicates the writing has been completed. Invokes this method beforeAuWriter.close(java.lang.Object, java.lang.Object)
, if the caller supports the resend mechanism. The caller usually stores the return value to a desktop byDesktopCtrl.responseSent(java.lang.String, java.lang.Object)
).Unlike
AuWriter.close(java.lang.Object, java.lang.Object)
, this method must be called in an activated execution.Once this method is called, the caller shall not invoke any other write method. It shall invoke only
AuWriter.close(java.lang.Object, java.lang.Object)
to end the writer.
-
resend
public void resend(java.lang.Object prevContent) throws java.io.IOException
Description copied from interface:AuWriter
Resend the content of the previous request returned byAuWriter.complete()
.The content is usually stored to a desktop by
DesktopCtrl.responseSent(java.lang.String, java.lang.Object)
, and retrieved byDesktopCtrl.getLastResponse(java.lang.String)
.Once this method is called, the caller shall not invoke any other write method nor
AuWriter.complete()
. It shall invoke onlyAuWriter.close(java.lang.Object, java.lang.Object)
to end the writer.- Specified by:
resend
in interfaceAuWriter
- Parameters:
prevContent
- the previous content returned byAuWriter.close(java.lang.Object, java.lang.Object)
of the previousAuWriter
.- Throws:
java.io.IOException
-
writeResponseId
public void writeResponseId(int resId) throws java.io.IOException
Description copied from interface:AuWriter
Generates the response ID to the output.- Specified by:
writeResponseId
in interfaceAuWriter
- Throws:
java.io.IOException
- See Also:
DesktopCtrl.getResponseId(boolean)
-
write
public void write(AuResponse response) throws java.io.IOException
Description copied from interface:AuWriter
Generates the specified the response to the output.
-
write
public void write(java.util.Collection<AuResponse> responses) throws java.io.IOException
Description copied from interface:AuWriter
Generates a list of responses to the output.
-
restore
protected byte[] restore(java.lang.Object data)
-
save
protected java.lang.Object save(byte[] data)
-
-