It's the main method to override, to define what is rendered by the CometActor

There are implicit conversions for a bunch of stuff to RenderOut (including NodeSeq). Thus, if you don't declare the return turn to be something other than RenderOut and return something that's coercible into RenderOut, the compiler "does the right thing"(tm) for you.
There are implicit conversions for NodeSeq, so you can return a pile of XML right here. There's an implicit conversion for NodeSeq => NodeSeq, so you can return a function (e.g., a CssBindFunc) that will convert the defaultHtml to the correct output. There's an implicit conversion from JsCmd, so you can return a pile of JavaScript that'll be shipped to the browser.
Note that the render method will be called each time a new browser tab is opened to the comet component or the comet component is otherwise accessed during a full page load (this is true if a partialUpdate has occurred.) You may want to look at the fixedRender method which is only called once and sets up a stable rendering state.

Set to 'true' if we should run "render" on every page load

Prepends the handler to the Json Handlers. Should only be used during instantiation

Convert a Seq[Node] (the superclass of NodeSeq) to a RenderOut. The render method returns a RenderOut. This method implicitly (in Scala) or explicitly (in Java) will convert a NodeSeq to a RenderOut. This is helpful if you return a NodeSeq from your render method.

Ask another CometActor a question. That other CometActor will take over the screen real estate until the question is answered.

Set this method to true to have the Json call code included in the Comet output

Creates the span element acting as the real estate for comet rendering.

By default, we do not cache the value of fixedRender. If it's expensive to recompute it each time there's a conversion of something to a RenderOut, override this method if you want to cache fixedRender.

Calculate fixedRender and capture the postpage javascript

Comet Actors live outside the HTTP request/response cycle. However, it may be useful to know what Request led to the creation of the CometActor. You can override this method and capture the initial Req object. Note that keeping a reference to the Req may lead to memory retention issues if the Req contains large message bodies, etc. It's optimal to capture the path or capture any request parameters that you care about rather the keeping the whole Req reference.

Clear the common dependencies for Wiring. This method will clearPostPageJavaScriptForThisPage() and unregisterFromAllDependencies(). The combination will result in a clean slate for Wiring during a redraw. You can change the behavior of the wiring dependency management by overriding this method

The locale for the session that created the CometActor

Return the list of ListenerIds of all long poll agents that are waiting for this CometActor to change its state. This method is useful for detecting presence.

Override in sub-class to customise timeout for AJAX-requests to the comet-component for the specific comet

This is to react to comet-requests timing out. When the timeout specified in LiftRules#cometProcessingTimeout occurs one may override this to send a message to the user informing of the timeout.

Do NOT manipulate actor-state here. If you want to manipulate state, send the actor a new message.

Typical example would be:

  override def cometTimeoutHandler(): JsCmd = {
    Alert("Timeout processing comet-request, timeout is: " + cometProcessingTimeout + "ms")
}

Override in sub-class to customise timeout for the render()-method for the specific comet

This is to react to comet-actors timing out while initial rendering, calls to render(). When the timeout specified in LiftRules#cometRenderTimeout occurs one may override this to customise the output.

Do NOT manipulate actor-state here. If you want to manipulate state, send the actor a new message.

Typical example would be:

  override def renderTimeoutHandler(): Box[NodeSeq] = {
    Full(<div>Comet {this.getClass} timed out, timeout is {cometRenderTimeout}ms</div>)
}

Compose the Message Handler function. By default, composes highPriority orElse mediumPriority orElse internalHandler orElse lowPriority orElse internalHandler. But you can change how the handler works if doing stuff in highPriority, mediumPriority and lowPriority is not enough.

The template that was passed to this component during comet initializations

Set this method to true if you want to avoid caching the rendering. This trades space for time.

Similar with S.error

Similar with S.error

Similar with S.error

Similar with S.error

By default, CometActor handles RedirectShortcutException, which is used to handle many types of redirects in Lift. If you override this PartialFunction to do your own exception handling and want redirects from e.g. S.redirectTo to continue working correctly, make sure you chain back to this implementation.

A part of the CometActor's screen real estate that is not updated by default with reRender(). This block of HTML is useful for the editor part of a Comet-based control where the data is JSON and updated with partialUpdates.

Handle messages sent to this Actor before the

It's seriously suboptimal to override this method. Instead use localSetup()

The JavaScript call that you use to send the data to the server. For example: <button onclick={jsonSend("Hello", JsRaw("Dude".encJs))}>Click</button>

The call that packages up the JSON and tosses it to the server. If you set autoIncludeJsonCode to true, then this will be included in the stuff sent to the server.

The last "when" sent from the listener

The lifespan of this component. By default CometActors will last for the entire session that they were created in, even if the CometActor is not currently visible. You can set the lifespan of the CometActor. If the CometActor isn't visible on any page for some period after its lifespan the CometActor will be shut down.

This method will be called when there's a change in the long poll listeners. The method does nothing, but allows you to get a granular sense of how many browsers care about this CometActor. Note that this method should not block for any material time and if there's any processing to do, use Scheduler.schedule or send a message to this CometActor. Do not change the Actor's state from this method.

First thing we do is registering this comet actor for the "name" key

We remove the CometActor from the map of registered actors

By default, Lift deals with managing wiring dependencies. This means on each full render (a full render will happen on reRender() or on a page load if there have been partial updates.) You may want to manually deal with wiring dependencies. If you do, override this method and return true

The optional name of this CometActors

A helpful implicit conversion that takes a NodeSeq => NodeSeq (for example a CssSel) and converts it to a Box[NodeSeq] by applying the function to defaultHtml

Similar with S.notice

Similar with S.notice

Similar with S.notice

Similar with S.notice

Convert a NodeSeq => NodeSeq to a RenderOut. The render method returns a RenderOut. This method implicitly (in Scala) or explicitly (in Java) will convert a NodeSeq => NodeSeq to a RenderOut. This is helpful if you use Lift's CSS Selector Transforms to define rendering.

If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.

Perform a partial update of the comet component based on the JsCmd. This means that the JsCmd will be sent to all of the currently listening browser tabs. This is the preferred method over reRender to update the component

Poke the CometActor and cause it to do a partial update Noop which will have the effect of causing the component to redisplay any Wiring elements on the component. This method is Actor-safe and may be called from any thread, not just the Actor's message handler thread.

If the predicate cell changes, the Dependent will be notified

Cause the entire component to be reRendered and pushed out to any listeners. This method will cause the entire component to be rendered which can result in a huge blob of JavaScript to be sent to the client. It's a much better practice to use partialUpdate for non-trivial CometActor components.

Cause the entire component to be reRendered and pushed out to any listeners. This method will cause the entire component to be rendered which can result in a huge blob of JavaScript to be sent to the client. It's a much better practice to use partialUpdate for non-trivial CometActor components.

Override this method to deal with JSON sent from the browser via the sendJson function. This is based on the Lift JSON package rather than the handleJson stuff based on the older util.JsonParser. This is the preferred mechanism. If you use the jsonSend call, you will get a JObject(JField("command", cmd), JField("param", params))

Get the current render clock for the CometActor

How to report an error that occurs during message dispatch

Is the CometActor running?

Is this CometActor going to capture the initial Req object? If yes, override this method and return true and override captureInitialReq to capture the Req. Why have to explicitly ask for the Req? In order to send Req instances across threads, the Req objects must be snapshotted which is the process of reading the POST or PUT body from the HTTP request stream. We don't want to do this unless we have to, so by default the Req is not snapshotted/sent. But if you want it, you can have it.

The optional type of this CometActor

Similar with S.warning

Similar with S.warning

Similar with S.warning

Similar with S.warning