Packages

t

net.liftweb.http

BaseCometActor

trait BaseCometActor extends LiftActor with LiftCometActor with CssBindImplicits

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseCometActor
  2. CssBindImplicits
  3. LiftCometActor
  4. Dependent
  5. LiftActor
  6. ForwardableActor
  7. GenericActor
  8. TypedActor
  9. SpecializedLiftActor
  10. SimpleActor
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class CssBindPromoter extends AnyRef
    Definition Classes
    CssBindImplicits
  2. implicit class CssSelectorToCssBindPromoter extends CssBindPromoter
    Definition Classes
    CssBindImplicits
  3. implicit class StringToCssBindPromoter extends CssBindPromoter
    Definition Classes
    CssBindImplicits

Abstract Value Members

  1. abstract def render: RenderOut

    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.

Concrete Value Members

  1. def !(msg: Any): Unit

    Send a message to the Actor.

    Send a message to the Actor. This call will always succeed and return almost immediately. The message will be processed asynchronously.

    Definition Classes
    SpecializedLiftActorSimpleActor
  2. def !!(msg: Any): Box[Any]

    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.

    Definition Classes
    LiftActorTypedActor
  3. def !!(msg: Any, timeout: Long): Box[Any]

    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.

    Definition Classes
    LiftActorTypedActor
  4. def !<(msg: Any): LAFuture[Any]

    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

    Definition Classes
    LiftActor
  5. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def !?(timeout: Long, message: Any): Box[Any]

    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.

    Definition Classes
    LiftActorTypedActor
  7. def !?(msg: Any): Any

    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.

    Definition Classes
    LiftActorTypedActor
  8. final def ##(): Int
    Definition Classes
    AnyRef → Any
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def alwaysReRenderOnPageLoad: Boolean

    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
    protected
  11. def answer(answer: Any): Unit
    Attributes
    protected
  12. def appendJsonHandler(h: PartialFunction[Any, JsCmd]): Unit

    Prepends the handler to the Json Handlers.

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

    h

    -- the PartialFunction that can handle a JSON request

  13. def around[R](f: ⇒ R): R

    You can wrap calls around the evaluation of the mailbox.

    You can wrap calls around the evaluation of the mailbox. This allows you to set up the environment.

    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  14. def aroundLoans: List[CommonLoanWrapper]

    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
    protected
    Definition Classes
    SpecializedLiftActor
  15. implicit def arrayToRenderOut(in: Seq[Node]): RenderOut

    Convert a Seq[Node] (the superclass of NodeSeq) to a RenderOut.

    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
    protected
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def ask(who: LiftCometActor, what: Any)(answerWith: (Any) ⇒ Unit): Unit

    Ask another CometActor a question.

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

    Attributes
    protected
  18. def attributes: Map[String, String]
  19. def autoIncludeJsonCode: Boolean

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

  20. def buildSpan(xml: NodeSeq): Elem

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

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

    Definition Classes
    BaseCometActorLiftCometActor
  21. def cacheFixedRender: Boolean

    By default, we do not cache the value of 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
    protected
  22. def calcFixedRender: Box[NodeSeq]

    Calculate fixedRender and capture the postpage javascript

    Calculate fixedRender and capture the postpage javascript

    Attributes
    protected
  23. def captureInitialReq(initialReq: Box[Req]): Unit

    Comet Actors live outside the HTTP request/response cycle.

    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
    protected
  24. def clearWiringDependencies(): Unit

    Clear the common dependencies for Wiring.

    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
    protected
  25. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def cometActorLocale: Locale

    The locale for the session that created the CometActor

    The locale for the session that created the CometActor

    Definition Classes
    LiftCometActor
  27. def cometListeners: List[ListenerId]

    Return the list of ListenerIds of all long poll agents that are waiting for this CometActor to change its state.

    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
    protected
  28. def cometProcessingTimeout: Long

    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

    Definition Classes
    LiftCometActor
  29. def cometProcessingTimeoutHandler(): JsCmd

    This is to react to comet-requests timing out.

    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")
    }
    

    Definition Classes
    LiftCometActor
  30. def cometRenderTimeout: Long

    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

    Definition Classes
    LiftCometActor
  31. def cometRenderTimeoutHandler(): Box[NodeSeq]

    This is to react to comet-actors timing out while initial rendering, calls to render().

    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>)
    }
    

    Definition Classes
    LiftCometActor
  32. def composeFunction: PartialFunction[Any, Unit]

    Compose the Message Handler function.

    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
    protected
  33. def defaultHtml: NodeSeq

    The template that was passed to this component during comet initializations

  34. def defaultPrefix: Box[String]
  35. def dontCacheRendering: Boolean

    Set this method to true if you want to avoid caching the rendering.

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

    Attributes
    protected
  36. implicit def elemToFull(in: Elem): Box[NodeSeq]
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def error(id: String, n: String): Unit

    Similar with S.error

  40. def error(id: String, n: NodeSeq): Unit

    Similar with S.error

  41. def error(n: NodeSeq): Unit

    Similar with S.error

  42. def error(n: String): Unit

    Similar with S.error

  43. def exceptionHandler: PartialFunction[Throwable, Unit]

    By default, CometActor handles RedirectShortcutException, which is used to handle many types of redirects in Lift.

    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.

    Definition Classes
    BaseCometActorSpecializedLiftActor
  44. def execTranslate(f: (Any) ⇒ Unit)(v: Any): Unit
    Attributes
    protected
    Definition Classes
    LiftActorSpecializedLiftActor
  45. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  46. def fixedRender: Box[NodeSeq]

    A part of the CometActor's screen real estate that is not updated by default with reRender().

    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.

  47. final def forwardMessageTo(msg: Any, forwardTo: TypedActor[Any, Any]): Unit
    Attributes
    protected
    Definition Classes
    LiftActorForwardableActor
  48. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  49. def hasOuter: Boolean
    Definition Classes
    BaseCometActorLiftCometActor
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  51. def highPriority: PartialFunction[Any, Unit]

    Handle messages sent to this Actor before the

  52. def highPriorityReceive: Box[PartialFunction[Any, Unit]]
    Attributes
    protected
    Definition Classes
    SpecializedLiftActor
  53. def initCometActor(creationInfo: CometCreationInfo): Unit

    It's seriously suboptimal to override this method.

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

    Attributes
    protected
    Definition Classes
    BaseCometActorLiftCometActor
  54. def insertMsgAtHeadOfQueue_!(msg: Any): Unit

    This method inserts the message at the head of the mailbox.

    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
    protected
    Definition Classes
    SpecializedLiftActor
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. implicit def jsToXmlOrJsCmd(in: JsCmd): RenderOut
    Attributes
    protected
  57. def jsonSend: JsonCall

    The JavaScript call that you use to send the data to the server.

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

  58. def jsonToIncludeInCode: JsCmd

    The call that packages up the JSON and tosses it 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.

  59. def lastListenerTime: Long

    The last "when" sent from the listener

    The last "when" sent from the listener

    returns

    the last when sent from the listener

    Definition Classes
    BaseCometActorLiftCometActor
  60. def lastRenderTime: Long
    Definition Classes
    BaseCometActorLiftCometActor
  61. def lifespan: Box[util.Helpers.TimeSpan]

    The lifespan of this component.

    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.

  62. def listenerTransition(): Unit

    This method will be called when there's a change in the long poll listeners.

    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
    protected
  63. def localSetup(): Unit

    This method will be called after the Actor has started.

    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
    protected
  64. def localShutdown(): Unit

    This method will be called as part of the shut-down of the actor.

    This method will be called as part of the shut-down of the actor. Release any resources here.

    Attributes
    protected
  65. def lowPriority: PartialFunction[Any, Unit]
  66. def manualWiringDependencyManagement: Boolean

    By default, Lift deals with managing wiring dependencies.

    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
    protected
  67. def mediumPriority: PartialFunction[Any, Unit]
  68. def messageHandler: PartialFunction[Any, Unit]
    Attributes
    protected
    Definition Classes
    BaseCometActorSpecializedLiftActor
  69. def name: Box[String]

    The optional name of this CometActors

    The optional name of this CometActors

    Definition Classes
    BaseCometActorLiftCometActor
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. implicit def nodeSeqFuncToBoxNodeSeq(f: (NodeSeq) ⇒ NodeSeq): Box[NodeSeq]

    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
    protected
  72. implicit def nodeSeqToFull(in: NodeSeq): Box[NodeSeq]
  73. def notice(id: String, n: String): Unit

    Similar with S.notice

  74. def notice(id: String, n: NodeSeq): Unit

    Similar with S.notice

  75. def notice(n: NodeSeq): Unit

    Similar with S.notice

  76. def notice(n: String): Unit

    Similar with S.notice

  77. final def notify(): Unit
    Definition Classes
    AnyRef
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  79. implicit def nsToNsFuncToRenderOut(f: (NodeSeq) ⇒ NodeSeq): RenderOut

    Convert a NodeSeq => NodeSeq to a RenderOut.

    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
    protected
  80. def onJsonError: Box[JsCmd]

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

  81. implicit def pairToPair(in: (String, Any)): (String, NodeSeq)
  82. def parentTag: Elem
    Definition Classes
    BaseCometActorLiftCometActor
  83. def partialUpdate(cmd: ⇒ JsCmd): Unit

    Perform a partial update of the comet component based on the JsCmd.

    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
    protected
  84. def poke(): Unit

    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.

    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.

    Definition Classes
    BaseCometActorLiftCometActor
  85. def predicateChanged(which: Cell[_]): Unit

    If the predicate cell changes, the Dependent will be notified

    If the predicate cell changes, the Dependent will be notified

    Definition Classes
    LiftCometActorDependent
  86. def reRender(): Unit

    Cause the entire component to be reRendered and pushed out to any listeners.

    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.

  87. def reRender(sendAll: Boolean): Unit

    Cause the entire component to be reRendered and pushed out to any listeners.

    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.

    sendAll

    -- Should the fixed part of the CometActor be rendered.

  88. def receiveJson: PartialFunction[JValue, JsCmd]

    Override this method to deal with JSON sent from the browser via the sendJson function.

    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))

  89. def renderClock: Long

    Get the current render clock for the CometActor

  90. def reply(v: Any): Unit

    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
    protected
    Definition Classes
    LiftActorForwardableActor
  91. def reportError(msg: String, exception: Exception): Unit

    How to report an error that occurs during message dispatch

    How to report an error that occurs during message dispatch

    Attributes
    protected
  92. def running: Boolean

    Is the CometActor running?

    Is the CometActor running?

    Attributes
    protected
  93. def send(msg: Any): Unit

    Send a message to the Actor.

    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 !.

    Definition Classes
    SpecializedLiftActor
  94. def sendAndGetFuture(msg: Any): LAFuture[Any]

    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. This method calls !< and is here for Java compatibility.

    Definition Classes
    LiftActor
  95. def sendAndGetReply(timeout: Long, msg: Any): Any

    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. This method is the Java callable version of !?.

    Definition Classes
    LiftActor
  96. def sendAndGetReply(msg: Any): Any

    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. This method is the Java callable version of !?.

    Definition Classes
    LiftActor
  97. def sendInitialReq_?: Boolean

    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.

    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.

    Definition Classes
    LiftCometActor
  98. def startQuestion(what: Any): Unit
    Attributes
    protected
  99. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  100. def testTranslate(f: (Any) ⇒ Boolean)(v: Any): Boolean
    Attributes
    protected
    Definition Classes
    LiftActorSpecializedLiftActor
  101. def theSession: LiftSession
  102. def theType: Box[String]

    The optional type of this CometActor

    The optional type of this CometActor

    Definition Classes
    BaseCometActorLiftCometActor
  103. def toString(): String
    Definition Classes
    AnyRef → Any
  104. def unWatch: Unit
  105. val uniqueId: String
    Definition Classes
    BaseCometActorLiftCometActor
  106. def unregisterFromAllDependencies(): Unit

    Remove from all dependencies

    Remove from all dependencies

    Attributes
    protected
    Definition Classes
    Dependent
  107. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. def warning(id: String, n: String): Unit

    Similar with S.warning

  111. def warning(id: String, n: NodeSeq): Unit

    Similar with S.warning

  112. def warning(n: NodeSeq): Unit

    Similar with S.warning

  113. def warning(n: String): Unit

    Similar with S.warning

  114. def whoDoIDependOn: Seq[Cell[_]]

    Get a list of all the cells this Dependency depends on

    Get a list of all the cells this Dependency depends on

    Attributes
    protected
    Definition Classes
    Dependent
  115. def youDependOnMe(who: Cell[_]): Unit

    The Cell notifies the Dependent of the dependency

    The Cell notifies the Dependent of the dependency

    Definition Classes
    Dependent
  116. def youDontDependOnMe(who: Cell[_]): Unit

    The Cell notifies the Dependent of the removed dependency

    The Cell notifies the Dependent of the removed dependency

    Definition Classes
    Dependent

Inherited from CssBindImplicits

Inherited from LiftCometActor

Inherited from Dependent

Inherited from LiftActor

Inherited from ForwardableActor[Any, Any]

Inherited from GenericActor[Any]

Inherited from TypedActor[Any, Any]

Inherited from SpecializedLiftActor[Any]

Inherited from SimpleActor[Any]

Inherited from AnyRef

Inherited from Any

Ungrouped