Packages

trait BodyReader extends AnyRef

Representation of a HTTP message body

Source
BodyReader.scala
Note

The release of resources must be idempotent, meaning that discard() may be called after complete consumption of the body and it may also be called numerous times.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BodyReader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply(): Future[ByteBuffer]

    Get a Future which may contain message body data.

    Get a Future which may contain message body data.

    If no data remains, the ByteBuffer will be empty as defined by ByteBuffer.hasRemaining()

  2. abstract def discard(): Unit

    Throw away this BodyReader

  3. abstract def isExhausted: Boolean

    Examine whether the BodyReader may yield additional data.

    Examine whether the BodyReader may yield additional data.

    This may be a result of being discarded, failure, or deletion of the data stream.

    Because BodyReader is async it is not, in general, possible to definitively determine if more data remains in the stream. Therefore, the contract of this method is that a return value of true guarantees that no more data can be obtained from this BodyReader, but a return value of false does not guarantee more data.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accumulate(max: Int = Int.MaxValue): Future[ByteBuffer]

    Accumulate any remaining data.

    Accumulate any remaining data.

    The remainder of the message body will be accumulated into a single buffer. If no data remains, the ByteBuffer will be empty as defined by ByteBuffer.hasRemaining()

    max

    maximum bytes to accumulate before resulting in a failed future with the exception BodyReader.BodyReaderOverflowException.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped