MessageCometActor
Attributes
- Graph
-
- Supertypes
-
trait BaseCometActortrait CssBindImplicitstrait LiftCometActortrait Dependenttrait LiftActortrait ForwardableActor[Any, Any]trait GenericActor[Any]trait TypedActor[Any, Any]trait SpecializedLiftActor[Any]trait SimpleActor[Any]class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class AsyncRenderComet
Members list
Type members
Inherited classlikes
Attributes
- Inherited from:
- CssBindImplicits
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class StringToCssBindPromoter
Attributes
- Inherited from:
- CssBindImplicits
- Supertypes
Attributes
- Inherited from:
- CssBindImplicits
- Supertypes
Value members
Concrete methods
It's the main method to override, to define what is rendered by the CometActor
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.
Attributes
- Definition Classes
Inherited methods
Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously.
Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously.
Attributes
- Inherited from:
- SpecializedLiftActor
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and wait for the actor to process the message and reply.
Send a message to the Actor and wait for the actor to process the message and reply.
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message
Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply.
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and wait for the actor to process the message and reply.
Send a message to the Actor and wait for the actor to process the message and reply.
Attributes
- Inherited from:
- LiftActor
Set to 'true' if we should run "render" on every page load
Set to 'true' if we should run "render" on every page load
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
Prepends the handler to the Json Handlers. Should only be used during instantiation
Prepends the handler to the Json Handlers. Should only be used during instantiation
Value parameters
- h
-
-- the PartialFunction that can handle a JSON request
Attributes
- Inherited from:
- BaseCometActor
You can wrap calls around the evaluation of the mailbox. This allows you to set up the environment.
You can wrap calls around the evaluation of the mailbox. This allows you to set up the environment.
Attributes
- Inherited from:
- SpecializedLiftActor
A list of LoanWrappers that will be executed around the evaluation of mailboxes
A list of LoanWrappers that will be executed around the evaluation of mailboxes
Attributes
- Inherited from:
- SpecializedLiftActor
Ask another CometActor a question. That other CometActor will take over the screen real estate until the question is answered.
Ask another CometActor a question. That other CometActor will take over the screen real estate until the question is answered.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
Set this method to true to have the Json call code included in the Comet output
Set this method to true to have the Json call code included in the Comet output
Attributes
- Inherited from:
- BaseCometActor
Creates the span element acting as the real estate for comet rendering.
Creates the span element acting as the real estate for comet rendering.
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
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
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
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
Override in sub-class to customise timeout for AJAX-requests to the comet-component for the specific comet
Override in sub-class to customise timeout for AJAX-requests to the comet-component for the specific comet
Attributes
- Inherited from:
- LiftCometActor
This is to react to comet-requests timing out. When the timeout specified in {[[olon.http.LiftRules#cometProcessingTimeout]]} occurs one may override this to send a message to the user informing of the timeout.
This is to react to comet-requests timing out. When the timeout specified in {[[olon.http.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") }
Attributes
- Inherited from:
- LiftCometActor
Override in sub-class to customise timeout for the render()-method for the specific comet
Override in sub-class to customise timeout for the render()-method for the specific comet
Attributes
- Inherited from:
- LiftCometActor
This is to react to comet-actors timing out while initial rendering, calls to render(). When the timeout specified in cometRenderTimeout at LiftRules occurs one may override this to customise the output.
This is to react to comet-actors timing out while initial rendering, calls to render(). When the timeout specified in cometRenderTimeout at LiftRules 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>)
}
Attributes
- Inherited from:
- LiftCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
The template that was passed to this component during comet initializations
The template that was passed to this component during comet initializations
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
Set this method to true if you want to avoid caching the rendering. This trades space for time.
Set this method to true if you want to avoid caching the rendering. This trades space for time.
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Definition Classes
-
BaseCometActor -> SpecializedLiftActor
- Inherited from:
- BaseCometActor
Attributes
- Definition Classes
-
LiftActor -> SpecializedLiftActor
- Inherited from:
- LiftActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- LiftActor
Attributes
- Inherited from:
- BaseCometActor
Handle messages sent to this Actor before the
Attributes
- Inherited from:
- SpecializedLiftActor
It's seriously suboptimal to override this method. Instead use localSetup()
It's seriously suboptimal to override this method. Instead use localSetup()
Attributes
- Inherited from:
- BaseCometActor
This method inserts the message at the head of the mailbox. It's protected because this functionality may or may not want to be exposed.
This method inserts the message at the head of the mailbox. It's protected because this functionality may or may not want to be exposed.
Attributes
- Inherited from:
- SpecializedLiftActor
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 JavaScript call that you use to send the data to the server. For example: <button onclick={jsonSend("Hello", JsRaw("Dude".encJs))}>Click</button>
Attributes
- Inherited from:
- BaseCometActor
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 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.
Attributes
- Inherited from:
- BaseCometActor
The last "when" sent from the listener
The last "when" sent from the listener
Attributes
- Returns
-
the last when sent from the listener
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
This method will be called after the Actor has started. Do any setup here. DO NOT do initialization in the constructor or in initCometActor... do it here.
This method will be called after the Actor has started. Do any setup here. DO NOT do initialization in the constructor or in initCometActor... do it here.
Attributes
- Inherited from:
- BaseCometActor
This method will be called as part of the shut-down of the actor. Release any resources here.
This method will be called as part of the shut-down of the actor. Release any resources here.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
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
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
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Definition Classes
-
BaseCometActor -> SpecializedLiftActor
- Inherited from:
- BaseCometActor
The optional name of this CometActors
Similar with S.notice
Similar with S.notice
Similar with S.notice
Similar with S.notice
If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.
If there's actor-specific JSON behavior on failure to make the JSON call, include the JavaScript here.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
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
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
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Definition Classes
- Inherited from:
- BaseCometActor
If the predicate cell changes, the Dependent will be notified
If the predicate cell changes, the Dependent will be notified
Attributes
- Inherited from:
- LiftCometActor
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.
Attributes
- Inherited from:
- BaseCometActor
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.
Value parameters
- sendAll
-
-- Should the fixed part of the CometActor be rendered.
Attributes
- Inherited from:
- BaseCometActor
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))
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))
Attributes
- Inherited from:
- BaseCometActor
Get the current render clock for the CometActor
The Actor should call this method with a reply to the message
The Actor should call this method with a reply to the message
Attributes
- Inherited from:
- LiftActor
How to report an error that occurs during message dispatch
How to report an error that occurs during message dispatch
Attributes
- Inherited from:
- BaseCometActor
Is the CometActor running?
Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously. This is a Java-callable alias for !.
Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously. This is a Java-callable alias for !.
Attributes
- Inherited from:
- SpecializedLiftActor
Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message. This method calls !< and is here for Java compatibility.
Send a message to the Actor and get an LAFuture that will contain the reply (if any) from the message. This method calls !< and is here for Java compatibility.
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply. This method is the Java callable version of !?.
Send a message to the Actor and wait for up to timeout milliseconds for the actor to process the message and reply. This method is the Java callable version of !?.
Attributes
- Inherited from:
- LiftActor
Send a message to the Actor and wait for the actor to process the message and reply. This method is the Java callable version of !?.
Send a message to the Actor and wait for the actor to process the message and reply. This method is the Java callable version of !?.
Attributes
- Inherited from:
- LiftActor
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.
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.
Attributes
- Inherited from:
- LiftCometActor
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Definition Classes
-
LiftActor -> SpecializedLiftActor
- Inherited from:
- LiftActor
Attributes
- Inherited from:
- BaseCometActor
The optional type of this CometActor
Attributes
- Inherited from:
- BaseCometActor
Remove from all dependencies
Remove from all dependencies
Attributes
- Inherited from:
- Dependent
Similar with S.warning
Similar with S.warning
Similar with S.warning
Similar with S.warning
Get a list of all the cells this Dependency depends on
Get a list of all the cells this Dependency depends on
Attributes
- Inherited from:
- Dependent
The Cell notifies the Dependent of the dependency
The Cell notifies the Dependent of the dependency
Attributes
- Inherited from:
- Dependent
The Cell notifies the Dependent of the removed dependency
The Cell notifies the Dependent of the removed dependency
Attributes
- Inherited from:
- Dependent
Inherited fields
Attributes
- Inherited from:
- BaseCometActor
Implicits
Inherited implicits
Attributes
- Inherited from:
- CssBindImplicits
Attributes
- Inherited from:
- CssBindImplicits
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.
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.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
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
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
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor
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.
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.
Attributes
- Inherited from:
- BaseCometActor
Attributes
- Inherited from:
- BaseCometActor