xitrum

Things that are usually used by application developers are put in this package for convenience, because when they want to use XXX, they can simply write:

import xitrum.XXX

To avoid polluting this namespace, things that are utilities should be put in package xitrum.util, not here.

Annotations and validators are put to package xitrum.annation and xitrum.validator because there are many of them. It's better for application developers to write:

import xitrum.annotation._
import xitrum.validator._

Linear Supertypes

AnyRef, Any

Content Hierarchy Learn more about scaladoc diagrams

Type Members

trait Action extends RequestEnv with SessionEnv with Log with Net with Filter with BasicAuth with Redirect with Url with Renderer with Responder with I18n

When there's a request comes in, action extending Action will be run directly on the current Netty IO thread.
trait ActorAction extends Actor with Action

An actor will be created when there's request.
class BasicAuthConfig extends AnyRef
abstract class Cache extends AnyRef

This is the interface for cache implementations of Xitrum.
trait Component extends Action
trait FutureAction extends Action

Actions extending FutureAction will be run asynchronously in a future.
class HttpsConfig extends AnyRef
trait I18n extends AnyRef
trait Log extends AnyRef

If you don't care about the class name where the log is made, without having to extend this trait, you can call like this directly: xitrum.
class MetricsConfig extends AnyRef
class PortConfig extends AnyRef
class RequestConfig extends AnyRef
class RequestVar[T] extends AnyRef
class ResponseConfig extends AnyRef
class ReverseProxyConfig extends AnyRef
class SessionConfig extends AnyRef
class SessionVar[T] extends AnyRef
trait SkipCsrfCheck extends AnyRef

By default all non-GET requests are checked for anti-CSRF token.
trait SockJsAction extends Actor with Action

An actor will be created when there's new SockJS session.
case class SockJsText(text: String) extends Product with Serializable
class StaticFileConfig extends AnyRef
class Version extends AnyRef
trait WebSocketAction extends Actor with Action

An actor will be created when there's request.
case class WebSocketBinary(bytes: Array[Byte]) extends Product with Serializable
case class WebSocketText(text: String) extends Product with Serializable
class XitrumConfig extends AnyRef

This represents things in xitrum.
class js extends FutureAction

To innclude xitrum.

Value Members

object Action
object Cache
object Config

See config/xitrum.
object DualConfig

Dual config means the config can be in either one of the 2 forms:
lazy val Log: Logger

This is a convenient helper to let you call like this directly: xitrum.
This is a convenient helper to let you call like this directly: xitrum.Log.debug("msg"), xitrum.Log.info("msg") etc.
If you do care about the class name where the log is made, use trait xitrum.Log.
lazy val Metrics: MetricBuilder
object Server
object WebSocketPing extends Product with Serializable

Pong is automatically sent by Xitrum, don't send it yourself.
object WebSocketPong extends Product with Serializable
package action
package annotation
package etag
package exception
package handler
package i18n
object js
package local
package metrics
lazy val root: String

Path to the root directory of the current project.
Path to the root directory of the current project. If you're familiar with Rails, this is the same as Rails.root.
package routing
package scope
package util
package validator
lazy val version: Version
package view

package xitrum

Type Members

trait Action extends RequestEnv with SessionEnv with Log with Net with Filter with BasicAuth with Redirect with Url with Renderer with Responder with I18n

trait ActorAction extends Actor with Action

class BasicAuthConfig extends AnyRef

abstract class Cache extends AnyRef

trait Component extends Action

trait FutureAction extends Action

class HttpsConfig extends AnyRef

trait I18n extends AnyRef

trait Log extends AnyRef

class MetricsConfig extends AnyRef

class PortConfig extends AnyRef

class RequestConfig extends AnyRef

class RequestVar[T] extends AnyRef

class ResponseConfig extends AnyRef

class ReverseProxyConfig extends AnyRef

class SessionConfig extends AnyRef

class SessionVar[T] extends AnyRef

trait SkipCsrfCheck extends AnyRef

trait SockJsAction extends Actor with Action

case class SockJsText(text: String) extends Product with Serializable

class StaticFileConfig extends AnyRef

class Version extends AnyRef

trait WebSocketAction extends Actor with Action

case class WebSocketBinary(bytes: Array[Byte]) extends Product with Serializable

case class WebSocketText(text: String) extends Product with Serializable

class XitrumConfig extends AnyRef

class js extends FutureAction

Value Members

object Action

object Cache

object Config

object DualConfig

lazy val Log: Logger

lazy val Metrics: MetricBuilder

object Server

object WebSocketPing extends Product with Serializable

object WebSocketPong extends Product with Serializable

package action

package annotation

package etag

package exception

package handler

package i18n

object js

package local

package metrics

lazy val root: String

package routing

package scope

package util

package validator

lazy val version: Version

package view

Inherited from AnyRef

Inherited from Any

Ungrouped