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

WebSocketFrame

Companion trait WebSocketFrame

object WebSocketFrame

Provides factory for WebSocketFrame.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

WebSocketFrame
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 apply(statusCode: StatusCode, key: Option[MaskingKey]): WebSocketFrame
Creates Close frame using supplied status code.
Creates Close frame using supplied status code.
statusCode
status code to serve as payload
key
masking key

Note
If there is Some masking key, it is used to mask status code.
def apply(isFinal: Boolean, isCompressed: Boolean, opcode: Opcode, key: Option[MaskingKey], data: Array[Byte]): WebSocketFrame
Creates WebSocket frame using supplied attributes.
Creates WebSocket frame using supplied attributes.
isFinal
indicates final frame of message
isCompressed
indicates compression
opcode
frame opcode
key
masking key
data
unmasked payload data

Note
If there is Some masking key, it is used to mask data.
def apply(isFinal: Boolean, isCompressed: Boolean, opcode: Opcode, key: Option[MaskingKey], length: Int, data: Array[Byte]): WebSocketFrame
Creates WebSocket frame using supplied attributes.
Creates WebSocket frame using supplied attributes.
isFinal
indicates final frame of message
isCompressed
indicates compression
opcode
frame opcode
key
masking key
length
payload length
data
unmasked payload data

Note
If there is Some masking key, it is used to mask data.
def apply(isFinal: Boolean, isCompressed: Boolean, opcode: Opcode, key: Option[MaskingKey], length: Long, payload: InputStream): WebSocketFrame
Creates WebSocket frame using supplied attributes.
Creates WebSocket frame using supplied attributes.
isFinal
indicates final frame of message
isCompressed
indicates compression
opcode
frame opcode
key
masking key
length
payload length
payload
input stream to payload
final def asInstanceOf[T0]: T0

Definition Classes
Any
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] )
final def getClass(): Class[_]

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

WebSocketFrame

Companion trait WebSocketFrame

object WebSocketFrame

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

HTTP Messages

WebSocketFrame 

Companion trait WebSocketFrame

object WebSocketFrame

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

WebSocketFrame