olon-webkit
API
Generated with
olon-webkit/olon/olon.http/LiftScreen/LocalAction

LocalAction

olon.http.LiftScreen.LocalAction
protected object LocalAction extends TransientRequestVar[String]

Attributes

Graph
Supertypes
trait AnyVarTrait[String, TransientRequestVar[String]]
trait HasCalcDefaultValue[String]
trait PSettableValueHolder[String]
trait SettableValueHolder
trait Settable
trait PValueHolder[String]
trait ValueHolder
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited types

type CleanUpParam = Box[LiftSession]

Attributes

Inherited from:
TransientRequestVar
type FuncType = (Box[String], Boolean) => Unit

The function takes a Box[T] (Full if the Var is being set, Empty if it's being cleared) and a Boolean indicating that the set function is setting to the default value.

The function takes a Box[T] (Full if the Var is being set, Empty if it's being cleared) and a Boolean indicating that the set function is setting to the default value.

Attributes

Inherited from:
AnyVarTrait
type ValueType = String

Attributes

Inherited from:
PValueHolder

Value members

Inherited methods

def apply(what: String): String

Set the session variable

Set the session variable

Value parameters

what

-- the value to set the session variable to

Attributes

Inherited from:
AnyVarTrait
def atomicUpdate(f: ValueType => ValueType): ValueType

Perform an atomic update of this Settable. The current value is passed to the function and the ValueHolder is set to the result of the function. This is enclosed in the performAtomicOperation method which will, by default, synchronize this instance

Perform an atomic update of this Settable. The current value is passed to the function and the ValueHolder is set to the result of the function. This is enclosed in the performAtomicOperation method which will, by default, synchronize this instance

Attributes

Inherited from:
Settable
override protected def clearFunc(name: String): Unit

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar
def doSync[F](f: => F): F

Different Vars require different mechanisms for synchronization. This method implements the Var specific synchronization mechanism

Different Vars require different mechanisms for synchronization. This method implements the Var specific synchronization mechanism

Attributes

Inherited from:
TransientRequestVar
def doWith[F](newVal: String)(f: => F): F

Change the value of the Var for the lifespan of the function

Change the value of the Var for the lifespan of the function

Attributes

Inherited from:
AnyVarTrait
override protected def findFunc(name: String): Box[String]

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar
def get: String

Shadow of the 'is' method

Shadow of the 'is' method

Attributes

Inherited from:
AnyVarTrait
def is: String

The current value of the variable

The current value of the variable

Attributes

Inherited from:
AnyVarTrait
def logUnreadVal: Boolean

This defines whether or not Lift will log when a RequestVar is set but then not read within the same request cycle. Change this to false to turn off logging. Logging can also be turned off globally via LiftRules.logUnreadRequestVars.

This defines whether or not Lift will log when a RequestVar is set but then not read within the same request cycle. Change this to false to turn off logging. Logging can also be turned off globally via LiftRules.logUnreadRequestVars.

Attributes

See also

LiftRules#logUnreadRequestVars

Inherited from:
TransientRequestVar
def onChange(f: FuncType): Unit

On any change to this Var, invoke the function. Changes are setting the value, clearing the value. There may not be a call if the Var goes out of scope (e.g., a RequestVar at the end of the Request).

On any change to this Var, invoke the function. Changes are setting the value, clearing the value. There may not be a call if the Var goes out of scope (e.g., a RequestVar at the end of the Request).

The function takes a Box[T] (Full if the Var is being set, Empty if it's being cleared) and a Boolean indicating that the set function is setting to the default value.

The function should execute very quickly (e.g., Schedule a function to be executed on a different thread).

The function should generally be set in Boot or when a singleton is created.

Value parameters

f

the function to execute on change

Attributes

Inherited from:
AnyVarTrait
protected def onShutdown(session: CleanUpParam): Unit

Attributes

Inherited from:
AnyVarTrait
def performAtomicOperation[T](f: => T): T

Perform an atomic operation on the Settable. By default synchronizes the instance, but it could use other mechanisms

Perform an atomic operation on the Settable. By default synchronizes the instance, but it could use other mechanisms

Attributes

Inherited from:
Settable
override protected def registerCleanupFunc(in: (Box[LiftSession]) => Unit): Unit

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar
final protected def registerGlobalCleanupFunc(in: CleanUpParam => Unit): Unit

Attributes

Inherited from:
AnyVarTrait
def remove(): Unit

Attributes

Inherited from:
AnyVarTrait
def set(what: String): String

Shadow of the apply method

Shadow of the apply method

Attributes

Inherited from:
AnyVarTrait
override protected def setFunc(name: String, value: String): Unit

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar
def setIfUnset(value: => String): String

Set the Var if it has not been calculated

Set the Var if it has not been calculated

Attributes

Inherited from:
AnyVarTrait
def set_?: Boolean

Has this Var been set or accessed and had its default value calculated

Has this Var been set or accessed and had its default value calculated

Attributes

Inherited from:
AnyVarTrait
protected def settingDefault_?: Boolean

Attributes

Inherited from:
AnyVarTrait
override protected def testWasSet(name: String, bn: String): Boolean

A non-side-effecting test if the value was initialized

A non-side-effecting test if the value was initialized

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
AnyVarTrait -> Any
Inherited from:
AnyVarTrait
def update(f: String => String): String

Applies the given function to the contents of this variable and sets the variable to the resulting value.

Applies the given function to the contents of this variable and sets the variable to the resulting value.

Value parameters

f

-- the function to apply and set the result from.

Attributes

Inherited from:
AnyVarTrait
override protected def wasInitialized(name: String, bn: String): Boolean

Attributes

Definition Classes
TransientRequestVar -> AnyVarTrait
Inherited from:
TransientRequestVar

Concrete fields

lazy override val `__nameSalt`: String

Inherited fields

lazy protected val name: String

Attributes

Inherited from:
AnyVarTrait
Generated with