StreamingResponse

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[T](toBuf: (T) ⇒ Buf, status: Status = Status.Ok, headers: Map[String, String] = Map(), prefix: Option[Buf] = None, separator: Option[Buf] = None, suffix: Option[Buf] = None, closeOnFinish: Closable = Closable.nop, closeGracePeriod: Duration = Duration.Zero)(asyncStream: ⇒ AsyncStream[T]): StreamingResponse[T, Unit]

Construct a StreamingResponse from an AsyncStream and a toBuf
Construct a StreamingResponse from an AsyncStream and a toBuf
toBuf
Function for converting messages to a binary Buf representation.
status
Status code of the generated response.
headers
Headers for the generated response.
prefix
Optional first chunk of the response body. Note that a separator will not be added between the prefix and the elements of the AsyncStream.
separator
Separator to be interleaved between each result of the AsyncStream.
suffix
Suffix to append to the end of the AsyncStream. Note that a separator will not be included between the last stream chunk and the suffix.
closeOnFinish
A hook for cleaning up resources after completion of the rendering process. Note that this will be called regardless of whether rendering the body is successful.
closeGracePeriod
The grace period provided to the closeable in closeOnFinish
asyncStream
The data that will represent the body of the response.
def apply[T, U](streamTransformer: (AsyncStream[T]) ⇒ AsyncStream[(U, Buf)], status: Status, headers: Map[String, String], onWrite: (U, Buf) ⇒ (Try[Unit]) ⇒ Unit, onDisconnect: () ⇒ Unit, closeGracePeriod: Duration)(asyncStream: ⇒ AsyncStream[T]): StreamingResponse[T, U]

Construct a StreamingResponse from an AsyncStream and an AsyncStream[T] => AsyncStream[(U, Buf)]
Construct a StreamingResponse from an AsyncStream and an AsyncStream[T] => AsyncStream[(U, Buf)]
A StreamingResponse is useful for streaming data back to the client in chunks: data will be rendered to the client as it resolves from the AsyncStream while also utilizing the back-pressure mechanisms provide by the underlying transport, preventing unnecessary resource consumption for properly constructed AsyncStreams.
T
The incoming type.
U
An auxiliary type passed to onWrite which may be helpful when executing the onWrite callback.
streamTransformer
Function which converts AsyncStream[T] to AsyncStream[(U, Buf)]
status
Status code of the generated response.
headers
Headers for the generated response.
onDisconnect
A hook to clean up resources upon disconnection, either normally or exceptionally.
closeGracePeriod
The grace period provided to close the Response.writer.
asyncStream
The data that will represent the body of the response.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
def jsonArray[T](toBuf: (T) ⇒ Buf, status: Status = Status.Ok, headers: Map[String, String] = Map(), closeOnFinish: Closable = Closable.nop, asyncStream: ⇒ AsyncStream[T]): StreamingResponse[T, Unit]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )

Related Docs: class StreamingResponse | package response

object StreamingResponse

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[T, U](streamTransformer: (AsyncStream[T]) ⇒ AsyncStream[(U, Buf)], status: Status, headers: Map[String, String], onWrite: (U, Buf) ⇒ (Try[Unit]) ⇒ Unit, onDisconnect: () ⇒ Unit, closeGracePeriod: Duration)(asyncStream: ⇒ AsyncStream[T]): StreamingResponse[T, U]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

def jsonArray[T](toBuf: (T) ⇒ Buf, status: Status = Status.Ok, headers: Map[String, String] = Map(), closeOnFinish: Closable = Closable.nop, asyncStream: ⇒ AsyncStream[T]): StreamingResponse[T, Unit]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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