ServerResultUtils

Type Members

sealed trait ConnectionHeader extends AnyRef

The connection header logic to use for the result.
final case class InvalidResult(reason: String, alternativeResult: Result) extends Product with Serializable

Used to indicate that a result can't be streamed.
final case class PerformChunkedTransferEncoding(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

A stream where the response should be chunk encoded.
sealed trait ResultStreaming extends AnyRef

Indicates the streaming strategy to use for returning the response.
final case class StreamWithClose(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

Used for responses that have unknown length and should be delimited by the connection closing.
final case class StreamWithKnownLength(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

A stream with a known length where the Content-Length header can be set.
final case class StreamWithStrictBody(body: Array[Byte]) extends ResultStreaming with Product with Serializable

A stream with bytes that are already entirely known.
final case class UseExistingTransferEncoding(transferEncodedEnum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

A stream where the response has already been encoded by the user, e.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
object DefaultClose extends ConnectionHeader with Product with Serializable

No Connection header should be sent.
object DefaultKeepAlive extends ConnectionHeader with Product with Serializable

No Connection header should be sent.
object SendClose extends ConnectionHeader with Product with Serializable

A Connection: close header should be sent.
object SendKeepAlive extends ConnectionHeader with Product with Serializable

A Connection: keep-alive header should be sent.
object StreamWithNoBody extends ResultStreaming with Product with Serializable

Used for responses that may not contain a body, e.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def cleanFlashCookie(requestHeader: RequestHeader, result: Result): Result

Update the result's Set-Cookie header so that it removes any Flash cookies we received in the incoming request.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def determineResultStreaming(requestHeader: RequestHeader, result: Result): Future[Either[InvalidResult, (ResultStreaming, ConnectionHeader)]]

Analyze the Result and determine how best to send it.
Analyze the Result and determine how best to send it. This may involve looking at headers, buffering the enumerator, etc. The returned value will indicate how to stream the result and will provide an Enumerator or Array with the result body that should be streamed.
CannotStream will be returned if the Result cannot be streamed to the given client. This can happen if a result requires Transfer-Encoding but the client uses HTTP 1.0. It can also happen if there is an error in the Result headers.
The ConnectionHeader returned for a successful result will indicate how the header should be set in the response header.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def readAheadOne[A](enum: Enumerator[A]): Future[Either[Option[A], Enumerator[A]]]

Start reading an Enumerator and see if it is only zero or one elements long.
Start reading an Enumerator and see if it is only zero or one elements long. - If zero-length, return Left(None). - If one-length, return the element in Left(Some(el)) - If more than one element long, return Right(enumerator) where enumerator is an Enumerator that contains *all* the input. Any already-read elements will still be included in this Enumerator.
def splitSetCookieHeaders(headers: Map[String, String]): Iterable[(String, String)]

Given a map of headers, split it into a sequence of individual headers.
Given a map of headers, split it into a sequence of individual headers. Most headers map into a single pair in the new sequence. The exception is the Set-Cookie header which we split into a pair for each cookie it contains. This allows us to work around issues with clients that can't handle combined headers. (Also RFC6265 says multiple headers shouldn't be folded together, which Play's API unfortunately does.)
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( ... )

object ServerResultUtils

Type Members

sealed trait ConnectionHeader extends AnyRef

final case class InvalidResult(reason: String, alternativeResult: Result) extends Product with Serializable

final case class PerformChunkedTransferEncoding(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

sealed trait ResultStreaming extends AnyRef

final case class StreamWithClose(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

final case class StreamWithKnownLength(enum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

final case class StreamWithStrictBody(body: Array[Byte]) extends ResultStreaming with Product with Serializable

final case class UseExistingTransferEncoding(transferEncodedEnum: Enumerator[Array[Byte]]) extends ResultStreaming with Product with Serializable

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

object DefaultClose extends ConnectionHeader with Product with Serializable

object DefaultKeepAlive extends ConnectionHeader with Product with Serializable

object SendClose extends ConnectionHeader with Product with Serializable

object SendKeepAlive extends ConnectionHeader with Product with Serializable

object StreamWithNoBody extends ResultStreaming with Product with Serializable

final def asInstanceOf[T0]: T0

def cleanFlashCookie(requestHeader: RequestHeader, result: Result): Result

def clone(): AnyRef

def determineResultStreaming(requestHeader: RequestHeader, result: Result): Future[Either[InvalidResult, (ResultStreaming, ConnectionHeader)]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def readAheadOne[A](enum: Enumerator[A]): Future[Either[Option[A], Enumerator[A]]]

def splitSetCookieHeaders(headers: Map[String, String]): Iterable[(String, String)]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped