org.vertx.scala.core.http

HttpClientResponse

class HttpClientResponse extends Self with ReadStream

Represents a client-side HTTP response.

An instance is provided to the user via a org.vertx.java.core.Handler instance that was specified when one of the HTTP method operations, or the generic String, org.vertx.java.core.Handler) method was called on an instance of org.vertx.scala.core.http.HttpClient.

It implements org.vertx.scala.core.streams.ReadStream so it can be used with org.vertx.scala.core.streams.Pump to pump data with flow control.

Instances of this class are not thread-safe.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpClientResponse
  2. ReadStream
  3. ReadSupport
  4. ExceptionSupport
  5. AsJava
  6. Self
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type J = java.core.http.HttpClientResponse

    The internal type of the Java wrapped class.

    The internal type of the Java wrapped class.

    Definition Classes
    HttpClientResponseReadStreamReadSupportExceptionSupport → AsJava

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val asJava: java.core.http.HttpClientResponse

    The internal instance of the Java wrapped class.

    The internal instance of the Java wrapped class.

    Definition Classes
    HttpClientResponse → AsJava
  8. def bodyHandler(handler: (Buffer) ⇒ Unit): HttpClientResponse

    Convenience method for receiving the entire request body in one piece.

    Convenience method for receiving the entire request body in one piece. This saves the user having to manually set a data and end handler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

    handler

    This handler will be called after all the body has been received.

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def cookies(): List[String]

    Returns the Set-Cookie headers (including trailers).

    Returns the Set-Cookie headers (including trailers).

    returns

    The Set-Cookie headers (including trailers).

  11. def dataHandler(handler: (Buffer) ⇒ Unit): HttpClientResponse.this.type

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data.

    Definition Classes
    ReadStreamReadSupport
  12. def endHandler(handler: ⇒ Unit): HttpClientResponse.this.type

    Set an end handler.

    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

    Definition Classes
    ReadStream
  13. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  15. def exceptionHandler(handler: (Throwable) ⇒ Unit): HttpClientResponse.this.type

    Set an exception handler.

    Set an exception handler.

    Definition Classes
    ExceptionSupport
  16. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. def headers(): MultiMap

    Returns the HTTP headers.

    Returns the HTTP headers.

    This method converts a Java collection into a Scala collection every time it gets called, so use it sensibly.

    returns

    The HTTP headers.

  20. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  22. def netSocket(): NetSocket

    Get a net socket for the underlying connection of this request.

    Get a net socket for the underlying connection of this request. USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.

    returns

    the net socket

  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def pause(): HttpClientResponse.this.type

    Pause the ReadSupport.

    Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

    Definition Classes
    ReadSupport
  26. def resume(): HttpClientResponse.this.type

    Resume reading.

    Resume reading. If the ReadSupport has been paused, reading will recommence on it.

    Definition Classes
    ReadSupport
  27. def statusCode(): Int

    Returns the HTTP status code of the response.

    Returns the HTTP status code of the response.

    returns

    The HTTP status code of the response.

  28. def statusMessage(): String

    Returns the HTTP status message of the response.

    Returns the HTTP status message of the response.

    returns

    The HTTP status message of the response.

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. def trailers(): MultiMap

    Returns the HTTP trailers.

    Returns the HTTP trailers.

    This method converts a Java collection into a Scala collection every time it gets called, so call it sensibly.

    returns

    The HTTP trailers.

  32. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def wrap[X](doStuff: ⇒ X): HttpClientResponse.this.type

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Attributes
    protected[this]
    Definition Classes
    Self

Inherited from ReadStream

Inherited from ReadSupport[Buffer]

Inherited from ExceptionSupport

Inherited from AsJava

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped