scamper20.0.0 < Back

Packages

package root
Provided herein is API documentation for Scamper, the HTTP library for Scala.
Provided herein is API documentation for Scamper, the HTTP library for Scala.

Definition Classes
root

package scamper

Defines core types.

HTTP Messages

At the core of Scamper is HttpMessage, which is a trait that defines the fundamental characteristics of an HTTP message. HttpRequest and HttpResponse extend the specification to define characteristics specific to their respective message types.

An HttpRequest is created using a factory method defined in its companion object. Or you can start with a RequestMethod and use builder methods to further define the request.

import scamper.Header
import scamper.Implicits.stringToUri
import scamper.RequestMethod.Registry.Get

val request = Get("/motd").setHeaders(
  Header("Host: localhost:8080"),
  Header("Accept: text/plain")
)

printf("Request Method: %s%n", request.method)
printf("Target URI: %s%n", request.target)

request.headers.foreach(println)

val host: Option[String] = request.getHeaderValue("Host")

An HttpResponse is created using a factory method defined in its companion object. Or you can start with a ResponseStatus and use builder methods to further define the response.

import scamper.{ BodyParser, Header }
import scamper.Implicits.stringToEntity
import scamper.ResponseStatus.Registry.Ok

val response = Ok("There is an answer.").setHeaders(
  Header("Content-Type: text/plain"),
  Header("Connection: close")
)

printf("Status Code: %s%n", response.statusCode)
printf("Reason Phrase: %s%n", response.reasonPhrase)

response.headers.foreach(println)

val contentType: Option[String] = response.getHeaderValue("Content-Type")

implicit val parser = BodyParser.text()

printf("Body: %s%n", response.as[String])

Definition Classes: root

package websocket
Provides WebSocket implementation.
Provides WebSocket implementation.

Definition Classes
scamper
InvalidWebSocketRequest
MaskingKey
Opcode
SecWebSocketAccept
SecWebSocketExtensions
SecWebSocketKey
SecWebSocketProtocol
SecWebSocketProtocolClient
SecWebSocketProtocolServer
SecWebSocketVersion
SecWebSocketVersionClient
SecWebSocketVersionServer
SessionState
StatusCode
WebSocket
WebSocketConnection
WebSocketError
WebSocketExtension
WebSocketFrame
WebSocketHandshakeFailure
WebSocketSession

scamper.websocket

WebSocket

object WebSocket

Provides utilities for WebSocket handshake.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

WebSocket
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
def acceptKey(key: String): String
Generates header value for Sec-WebSocket-Accept using supplied WebSocket key.
Generates header value for Sec-WebSocket-Accept using supplied WebSocket key.
key
WebSocket key
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkHandshake(req: HttpRequest, res: HttpResponse): Boolean
Checks for successful WebSocket handshake based on supplied request and response.
Checks for successful WebSocket handshake based on supplied request and response.
req
WebSocket request
res
WebSocket response
returns
true if handshake is successful; false otherwise
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def generateKey(): String
Generates WebSocket key.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
val guid: String
Globally Unique Identifier – 258EAFA5-E914-47DA-95CA-C5AB0DC85B11
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isUpgrade(res: HttpResponse): Boolean
Tests response for WebSocket upgrade.
Tests response for WebSocket upgrade.
res
response
def isUpgrade(req: HttpRequest): Boolean
Tests request for WebSocket upgrade.
Tests request for WebSocket upgrade.
req
request
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
def validate(req: HttpRequest): HttpRequest
Validates WebSocket request.
Validates WebSocket request.
req
WebSocket request
returns
unmodified WebSocket request

Exceptions thrown
InvalidWebSocketRequest if WebSocket request is invalid
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

HTTP Messages

WebSocket

object WebSocket

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

HTTP Messages

WebSocket 

object WebSocket

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

WebSocket