Packages

abstract class Message extends AnyRef

Rich Message

Base class for Request and Response. There are both input and output methods, though only one set of methods should be used.

Linear Supertypes
AnyRef, Any
Known Subclasses
Request, Proxy, RequestProxy, Response, Proxy, ResponseProxy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Message
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Message()

Abstract Value Members

  1. abstract def chunkReader: Reader[Chunk]

    A read-only handle to a stream of Chunk, representing the message body.

    A read-only handle to a stream of Chunk, representing the message body. This stream is only populated on chunked messages (isChunked == true). Use content to access a payload of a fully-buffered message (isChunked == false).

    Prefer this API over reader when application needs to receive trailing headers (trailers). Trailers are transmitted in the very last chunk (chunk.isLast == true) of the stream and can be retrieved via Chunk.trailers.

    See also

    Reader and Chunk

  2. abstract def chunkWriter: Writer[Chunk]

    A write-only handle to a stream of Chunk, representing the message body.

    A write-only handle to a stream of Chunk, representing the message body. Only chunked messages (isChunked == true) use this stream as their payload, fully-buffered messages (isChunked == false) use content instead.

    Prefer this API over writer when application needs to send trailing headers (trailers). Trailers are transmitted in the very last chunk of the stream and can be populated via Chunk.last factory method.

    See also

    Reader and Chunk

  3. abstract def headerMap: HeaderMap

    HTTP headers associated with this message.

    HTTP headers associated with this message.

    Note

    HeaderMap isn't thread-safe. Any concurrent access should be synchronized externally.

  4. abstract def isRequest: Boolean
  5. abstract def trailers: HeaderMap

    Trailing headers (trailers) associated with this message.

    Trailing headers (trailers) associated with this message.

    These are only populated on fully-buffered inbound messages that were aggregated (see withStreaming(false)) from HTTP streams terminating with trailers.

    Note

    HeaderMap isn't thread-safe. Any concurrent access should be synchronized externally.

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 accept: Seq[String]

    Accept header

  5. def acceptMediaTypes: Seq[String]

    Accept header media types (normalized, no parameters)

  6. def accept_=(values: Iterable[String]): Unit

    Set Accept header with list of values

  7. def accept_=(value: String): Unit

    Set Accept header

  8. def addCookie(cookie: Cookie): Unit

    Add a cookie

  9. def allow: Option[String]

    Allow header

  10. def allow_=(values: Iterable[Method]): Unit

    Set Authorization header

  11. def allow_=(value: String): Unit

    Set Authorization header

  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def authorization: Option[String]

    Get Authorization header

  14. def authorization_=(value: String): Unit

    Set Authorization header

  15. def cacheControl: Option[String]

    Get Cache-Control header

  16. def cacheControl_=(maxAge: Duration): Unit

    Set Cache-Control header with a max-age (and must-revalidate).

  17. def cacheControl_=(value: String): Unit

    Set Cache-Control header

  18. def charset: Option[String]

    Get charset from Content-Type header

  19. def charset_=(value: String): Unit

    Set charset in Content-Type header.

    Set charset in Content-Type header. This does not change the content.

  20. final def clearContent(): Unit

    Clear content (set to "").

  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  22. def close(): Future[Unit]

    End the response stream.

  23. final def content(content: Buf): Message.this.type

    Set the content of this Message.

    Set the content of this Message.

    Any existing content is discarded. If this Message is set to chunked, an IllegalStateException is thrown.

    Annotations
    @throws(scala.this.throws.<init>$default$1[IllegalStateException])
    See also

    content_=(Buf) for Scala users

  24. def content: Buf

    Retrieve the current content of this Message.

    Retrieve the current content of this Message.

    If this message is chunked, the resulting Buf will always be empty.

  25. final def contentLength(value: Long): Message.this.type

    Set Content-Length header.

    Set Content-Length header. Normally, this is automatically set by the Codec, but this method allows you to override that.

    See also

    contentLength_=(Long) for Scala users.

  26. def contentLength: Option[Long]

    Get the value of the Content-Length header.

    Get the value of the Content-Length header. Use length to get the length of actual content.

    See also

    Long for Java users.

  27. final def contentLengthOrElse(default: Long): Long

    Get the value of the Content-Length header, or the provided default if it doesn't exist.

    Get the value of the Content-Length header, or the provided default if it doesn't exist.

    See also

    Option(Long) for Scala users.

  28. def contentLength_=(value: Long): Unit

    Set Content-Length header.

    Set Content-Length header. Normally, this is automatically set by the Codec, but this method allows you to override that.

    See also

    contentLength(Long) for Java users.

  29. def contentString: String

    Get the content as a string.

  30. def contentString_=(value: String): Unit

    Set the content as a string.

  31. def contentType: Option[String]

    Get Content-Type header

  32. def contentType_=(value: String): Unit

    Set Content-Type header

  33. def content_=(content: Buf): Unit

    Set the content of this Message.

    Set the content of this Message.

    Any existing content is discarded. If this Message is set to chunked, an IllegalStateException is thrown.

    Annotations
    @throws(scala.this.throws.<init>$default$1[IllegalStateException])
    See also

    content(Buf) for Java users

  34. lazy val cookies: CookieMap

    Cookies.

    Cookies. In a request, this uses the Cookie headers. In a response, it uses the Set-Cookie headers.

  35. def date: Option[String]

    Get Date header

  36. def date_=(value: Date): Unit

    Set Date header by Date

  37. def date_=(value: String): Unit

    Set Date header

  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  40. def expires: Option[String]

    Get Expires header

  41. def expires_=(value: Date): Unit

    Set Expires header by Date

  42. def expires_=(value: String): Unit

    Set Expires header

  43. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  44. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def getContentString(): String
  46. def getCookies(): Iterator[Cookie]

    Get iterator over Cookies

  47. final def getInputStream(): InputStream

    Get InputStream for content.

    Get InputStream for content. Caller must close. (Java interface. Scala users should use withInputStream.)

  48. final def getLength(): Int

    Get length of content.

  49. final def getReader(): Reader

    Get Reader for content.

    Get Reader for content. (Java interface. Scala users should use withReader.)

  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. final def host(value: String): Message.this.type

    Set the Host header

    Set the Host header

    See also

    host_=(String) for Scala users

  52. def host: Option[String]

    Get Host header

  53. def host_=(value: String): Unit

    Set Host header

    Set Host header

    See also

    host(String) for Java users

  54. def isChunked: Boolean
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. def isResponse: Boolean
  57. def isXmlHttpRequest: Boolean

    Check if X-Requested-With contains XMLHttpRequest, usually signalling a request from a JavaScript AJAX libraries.

    Check if X-Requested-With contains XMLHttpRequest, usually signalling a request from a JavaScript AJAX libraries. Some servers treat these requests specially. For example, an endpoint might render JSON or XML instead HTML if it's an XmlHttpRequest. (Tip: don't do this - it's gross.)

  58. final def keepAlive: Boolean
  59. final def keepAlive(keepAlive: Boolean): Message.this.type
  60. def lastModified: Option[String]

    Get Last-Modified header

  61. def lastModified_=(value: Date): Unit

    Set Last-Modified header by Date

  62. def lastModified_=(value: String): Unit

    Set Last-Modified header

  63. final def length: Int

    Get length of content.

  64. def location: Option[String]

    Get Location header

  65. def location_=(value: String): Unit

    Set Location header

  66. def mediaType: Option[String]

    Get media-type from Content-Type header

  67. def mediaType_=(value: String): Unit

    Set media-type in Content-Type header.

    Set media-type in Content-Type header. Charset and parameter values are preserved, though may not be appropriate for the new media type.

  68. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  69. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  71. final lazy val reader: Reader[Buf]

    A read-only handle to a stream of Buf, representing the message body.

    A read-only handle to a stream of Buf, representing the message body. This stream is only * populated on chunked messages (isChunked == true). Use content to access a payload of a fully-buffered message (isChunked == false).

    Prefer this API over chunkReader when application doesn't need access to trailing headers (trailers).

    See also

    Reader

  72. def referer: Option[String]

    Get Referer [sic] header

  73. def referer_=(value: String): Unit

    Set Referer [sic] header

  74. def removeCookie(name: String): Unit

    Remove a cookie

  75. def retryAfter: Option[String]

    Get Retry-After header

  76. def retryAfter_=(value: Long): Unit

    Set Retry-After header by seconds

  77. def retryAfter_=(value: String): Unit

    Set Retry-After header

  78. def server: Option[String]

    Get Server header

  79. def server_=(value: String): Unit

    Set Server header

  80. def setChunked(chunked: Boolean): Unit

    Manipulate the Message content mode.

    Manipulate the Message content mode.

    If chunked is true, any existing content will be discarded and further attempts to manipulate the synchronous content will result in an IllegalStateException.

    If chunked is false, the synchronous content methods will become available and the Reader/Writer of the message will be ignored by Finagle.

  81. final def setContentString(value: String): Unit

    Set the content as a string.

  82. def setContentType(mediaType: String, charset: String = "utf-8"): Unit

    Set Content-Type header by media-type and charset

  83. def setContentTypeJson(): Unit

    Set Content-Type header to application/json;charset=utf-8

  84. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  85. def toString(): String
    Definition Classes
    AnyRef → Any
  86. def userAgent: Option[String]

    Get User-Agent header

  87. def userAgent_=(value: String): Unit

    Set User-Agent header

  88. final def version(version: Version): Message.this.type

    Set the HTTP version

    Set the HTTP version

    * @see version_=(Version) for Scala users

  89. def version: Version

    Get the HTTP version

  90. def version_=(version: Version): Unit

    Set the HTTP version

    Set the HTTP version

    See also

    version(Version) for Java users

  91. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  92. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  93. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  94. def withInputStream[T](f: (InputStream) => T): T

    Use content as InputStream.

    Use content as InputStream. The underlying channel buffer's reader index is advanced. (Scala interface. Java users can use getInputStream().)

  95. final def withOutputStream[T](f: (OutputStream) => T): T

    Append content via an OutputStream.

    Append content via an OutputStream.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws(classOf[IllegalStateException])
  96. final def withReader[T](f: (Reader) => T): T

    Use content as Reader.

    Use content as Reader. (Scala interface. Java users can use getReader().)

  97. final def withWriter[T](f: (Writer) => T): T

    Append content via a Writer.

    Append content via a Writer.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws(classOf[IllegalStateException])
  98. final def write(bytes: Array[Byte]): Unit

    Append bytes to content.

    Append bytes to content.

    This method makes a defensive copy of the provided byte array. This can be avoided by wrapping the byte array via Buf.ByteArray.Owned and using the write(Buf) method.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws(classOf[IllegalStateException])
  99. final def write(buf: Buf): Unit

    Append a Buf to content.

    Append a Buf to content.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws(classOf[IllegalStateException])
  100. final def write(string: String): Unit

    Append string to content.

    Append string to content.

    An IllegalStateException is thrown if this message is chunked.

    Annotations
    @throws(classOf[IllegalStateException])
  101. final lazy val writer: Writer[Buf]

    A write-only handle to the stream of Buf, representing the message body.

    A write-only handle to the stream of Buf, representing the message body. Only chunked messages (isChunked == true) use this stream as their payload, fully-buffered messages (isChunked == false) use content instead.

    Prefer this API over chunkWriter when application doesn't need to send trailing headers (trailers).

    See also

    Writer

  102. def wwwAuthenticate: Option[String]

    Get WWW-Authenticate header

  103. def wwwAuthenticate_=(value: String): Unit

    Set WWW-Authenticate header

  104. def xForwardedFor: Option[String]

    Get X-Forwarded-For header

  105. def xForwardedFor_=(value: String): Unit

    Set X-Forwarded-For header

Inherited from AnyRef

Inherited from Any

Ungrouped