< Back

Packages

package root
Definition Classes
root
package play
Play framework.
Play framework.
Play
http://www.playframework.com
Definition Classes
root

package api

Contains the public API for Scala developers.

Contains the public API for Scala developers.

Read configuration

val poolSize = configuration.getInt("engine.pool.size")

Use the logger

Logger.info("Hello!")

Define a Plugin

class MyPlugin(app: Application) extends Plugin

Create adhoc applications (for testing)

val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)

Definition Classes: play

package mvc
Contains the Controller/Action/Result API to handle HTTP requests.
Contains the Controller/Action/Result API to handle HTTP requests.
For example, a typical controller:
```
class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
```
Definition Classes
api
package akkahttp
Definition Classes
mvc
package macros
Definition Classes
mvc
package request
Definition Classes
mvc
AbstractController
AcceptExtractors
Accepting
Action
ActionBuilder
ActionBuilderImpl
ActionFilter
ActionFunction
ActionRefiner
ActionTransformer
AnyContent
AnyContentAsEmpty
AnyContentAsFormUrlEncoded
AnyContentAsJson
AnyContentAsMultipartFormData
AnyContentAsRaw
AnyContentAsText
AnyContentAsXml
BaseController
BaseControllerHelpers
BodyParser
BodyParserUtils
BodyParsers
Call
Codec
ControllerComponents
ControllerHelpers
Cookie
CookieBaker
CookieDataCodec
CookieHeaderEncoding
CookieHeaderMerging
Cookies
CookiesModule
DefaultActionBuilder
DefaultActionBuilderImpl
DefaultControllerComponents
DefaultCookieHeaderEncoding
DefaultFlashCookieBaker
DefaultJWTCookieDataCodec
DefaultMessagesActionBuilderImpl
DefaultMessagesControllerComponents
DefaultPlayBodyParsers
DefaultSessionCookieBaker
DefaultUrlEncodedCookieDataCodec
DiscardingCookie
EssentialAction
EssentialFilter
FallbackCookieDataCodec
Filter
FilterChain
Filters
Flash
FlashCookieBaker
Handler
Headers
InjectedController
JWTCookieDataCodec
JavascriptLiteral
LegacyCookiesModule
LegacyFlashCookieBaker
LegacyI18nSupport
LegacySessionCookieBaker
MaxSizeExceeded
MaxSizeNotExceeded
MaxSizeStatus
MessagesAbstractController
MessagesActionBuilder
MessagesActionBuilderImpl
MessagesBaseController
MessagesControllerComponents
MessagesInjectedController
MessagesRequest
MessagesRequestHeader
MultipartFormData
PathBindable
PlayBodyParsers
PreferredMessagesProvider
QueryStringBindable
RangeResult
RawBuffer
Rendering
Request
RequestExtractors
RequestHeader
RequestImplicits
ResponseHeader
Result
Results
Security
Session
SessionCookieBaker
UrlEncodedCookieDataCodec
WebSocket
WrappedRequest

t

play.api.mvc

WebSocket

Companion object WebSocket

trait WebSocket extends Handler

A WebSocket handler.

Source: WebSocket.scala

Linear Supertypes

Handler, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

WebSocket
Handler
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def apply(request: RequestHeader): Future[Either[Result, Flow[Message, Message, _]]]
Execute the WebSocket.
Execute the WebSocket.
The return value is either a result to reject the WebSocket with (or otherwise respond in a different way), or a flow to handle the WebSocket messages.

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Handler

Inherited from AnyRef

Inherited from Any

Ungrouped