http

Type Members

1. class Cookie extends AnyRef

   

   Scala wrapper around Netty cookies.

2. class CookieMap extends Map[String, Cookie] with MapLike[String, Cookie, CookieMap]

   

   Adapt cookies of a Message to a mutable Map where cookies are indexed by their name.

   Adapt cookies of a Message to a mutable Map where cookies are indexed by their name. Requests use the Cookie header and Responses use the Set-Cookie header. If a cookie is added to the CookieMap, a header is automatically added to the Message. You can add the same cookie more than once. Use getAll to retrieve all of them, otherwise only the first one is returned. If a cookie is removed from the CookieMap, a header is automatically removed from the message

3. case class FileElement(name: String, content: Buf, contentType: Option[String] = None, filename: Option[String] = None) extends FormElement with Product with Serializable

   

4. sealed abstract class FormElement extends AnyRef

   

5. abstract class HeaderMap extends Map[String, String] with MapLike[String, String, HeaderMap]

   

   Mutable message headers map.

   Mutable message headers map.

   Header names are case-insensitive. For example, get("accept") is the same as get("Accept").

   The map is a multi-map. Use getAll to get all values for a key. Use add to append a key-value.

6. case class Http(_compressionLevel: Int = 1, _maxRequestSize: StorageUnit = 5.megabytes, _maxResponseSize: StorageUnit = 5.megabytes, _decompressionEnabled: Boolean = true, _channelBufferUsageTracker: Option[ChannelBufferUsageTracker] = None, _annotateCipherHeader: Option[String] = None, _enableTracing: Boolean = false, _maxInitialLineLength: StorageUnit = 4096.bytes, _maxHeaderSize: StorageUnit = 8192.bytes, _streaming: Boolean = false, _statsReceiver: StatsReceiver = NullStatsReceiver) extends CodecFactory[Request, Response] with Product with Serializable

   
   _compressionLevel

   The compression level to use. If passed the default value (-1) then use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use HttpContentCompressor for all content-types with specified compression level.

   _maxRequestSize

   The maximum size of the inbound request an HTTP server constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

   _maxResponseSize

   The maximum size of the inbound response an HTTP client constructed with this codec can receive (default is 5 megabytes). Should be less than 2 gigabytes (up to Int.MaxValue bytes). Use streaming/chunked requests to handle larger messages.

   _streaming

   Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies. When this flag is set to true, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream. If false, the entire message content is buffered into a com.twitter.io.Buf.

7. trait HttpMuxHandler extends Service[Request, Response]

   

   Trait HttpMuxHandler is used for service-loading HTTP handlers.

8. class HttpMuxer extends Service[Request, Response]

   

   A service that dispatches incoming requests to registered handlers.

   A service that dispatches incoming requests to registered handlers. In order to choose which handler to dispatch the request to, we take the path of the request and match it with the patterns of the pre-registered handlers. The pattern matching follows these rules:

   • Patterns ending with "/" use exclusive prefix matching. Eg: the pattern "foo/bar/" matches these paths: "foo/bar/", "foo/bar/baz", etc but NOT "foo/bar" Similarly, the pattern "/" matches all paths
   • Patterns not ending with "/" use exact matching. Eg: the pattern "foo/bar" ONLY matches this path: "foo/bar"
   • Special case: The pattern "" matches only "/" and ""

   NOTE: When multiple pattern matches exist, the longest pattern wins.

9. class MapHeaderMap extends HeaderMap

   

   Mutable-Map-backed HeaderMap

10. class MapParamMap extends ParamMap

    

    Map-backed ParamMap.

11. abstract class Message extends AnyRef

    

    Rich Message

    Rich Message

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

12. sealed abstract class Method extends AnyRef

    

    Represents the HTTP method.

    Represents the HTTP method.

    For Java-friendly enums, see com.twitter.finagle.http.Methods.

13. final class Methods extends AnyRef

    

14. abstract class ParamMap extends Map[String, String] with MapLike[String, String, ParamMap]

    

    Request parameter map.

    Request parameter map.

    This is a multi-map. Use getAll() get all values for a key.

15. case class ProxyCredentials(username: String, password: String) extends Product with Serializable

    

16. abstract class Request extends Message

    

    Rich HttpRequest.

    Rich HttpRequest.

    Use RequestProxy to create an even richer subclass.

17. class RequestBuilder[HasUrl, HasForm] extends AnyRef

    

18. class RequestParamMap extends ParamMap

    

    HttpRequest-backed param map.

    HttpRequest-backed param map. Handle parameters in the URL and form encoded body. Multipart forms are not supported (not needed, could be abusive).

    This map is a multi-map. Use getAll() to get all values for a key.

19. abstract class RequestProxy extends Request

    

    Proxy for Request.

    Proxy for Request. This can be used to create a richer request class that wraps Request without exposing the underlying netty http type.

20. abstract class Response extends Message

    

    Rich HttpResponse

21. abstract class ResponseProxy extends Response

    

22. class SafeHttpServerCodec extends HttpServerCodec

    

    Convert exceptions to BadHttpRequests

23. case class SimpleElement(name: String, content: String) extends FormElement with Product with Serializable

    

24. case class Status(code: Int) extends Product with Serializable

    

    Represents an HTTP status code.

    Represents an HTTP status code.

    The set of commonly known HTTP status codes have an associated reason phrase (see reasons). We don't provide a way to set the reason phrase because:

    - it simplifies construction (users only supply the code) - it avoids the need to validate user-defined reason phrases - it omits the possibility of statuses with duplicate reason phrases

    The only downside is that we lose the ability to create custom statuses with "vanity" reason phrases, but this should be tolerable.

    For Java-friendly enums, see com.twitter.finagle.http.Statuses.

25. final class Statuses extends AnyRef

    

26. class TlsFilter extends SimpleFilter[Request, Response]

    

    Adds the host headers to for TLS-enabled requests.

27. sealed abstract class Version extends AnyRef

    

    Represents the HTTP version.

    Represents the HTTP version.

    For Java-friendly enums, see com.twitter.finagle.http.Versions.

28. final class Versions extends AnyRef