| java.lang.Object
 org.directwebremoting.extend.ScriptConduit
org.directwebremoting.dwrp.BaseScriptConduit
All known Subclasses: org.directwebremoting.dwrp.HtmlScriptConduit, org.directwebremoting.dwrp.Html4kScriptConduit, org.directwebremoting.dwrp.PlainScriptConduit,
| BaseScriptConduit | | abstract public class BaseScriptConduit extends ScriptConduit (Code) | | A ScriptConduit that works with the parent Marshaller.
In some ways this is nasty because it has access to essentially private parts
of PollHandler, however there is nowhere sensible to store them
within that class, so this is a hacky simplification.
author:
Joe Walker [joe at getahead dot ltd dot uk] |
| alarm | | protected BasicAlarm alarm(Code) | | An Alarm that goes off if something is badly broken
|
| batchId | | final protected String batchId(Code) | | What is the ID of the request that we are responding to?
|
| debugScriptOutput | | protected boolean debugScriptOutput(Code) | | Do we debug all the scripts that we output?
|
| jsonOutput | | protected boolean jsonOutput(Code) | | Are we outputting in JSON mode?
|
| out | | protected PrintWriter out(Code) | | The PrintWriter to send output to, and that we should synchronize against
|
| BaseScriptConduit | | public BaseScriptConduit(HttpServletResponse response, String batchId, ConverterManager converterManager, boolean jsonOutput) throws IOException(Code) | | Simple ctor
Parameters:
response - Used to flush output
Parameters:
batchId - The id of the batch that we are responding to
Parameters:
converterManager - How we convert objects to script
throws:
IOException - If stream actions fail |
| beginStream | | abstract protected void beginStream()(Code) | | Called when we are initially setting up the stream. This does not send
any data to the client, just sets it up for data.
This method is always called exactly once in the lifetime of a
conduit.
|
| close | | public void close(int timetoNextPoll) throws IOException(Code) | | A poll has finished, get the client to call us back
Parameters:
timetoNextPoll - How long before we tell the browser to come back?
throws:
IOException - When we fail to call endStream() |
| endStream | | abstract protected void endStream()(Code) | | Called when we are shutting the stream down.
This method is always called exactly once in the lifetime of a
conduit, just before the stream is closed.
|
| flush | | protected boolean flush()(Code) | | Ensure that output we have done is written to the client
true/false depending on the write status |
| getErrorAlarm | | public Alarm getErrorAlarm()(Code) | | The Alarm that goes off if something is badly broken |
| getOutboundMimeType | | abstract protected String getOutboundMimeType()(Code) | | What mime type should we send to the browser for this data?
A mime-type |
| setDebugScriptOutput | | public void setDebugScriptOutput(boolean debugScriptOutput)(Code) | | Do we debug all the scripts that we output?
Parameters:
debugScriptOutput - true to debug all of the output scripts (verbose) |
|
|