Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2293)

Unified Diff: dart/pkg/http_base/lib/http_base.dart

Issue 299443013: Add initial version of http_base package (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge
Patch Set: Created 6 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: dart/pkg/http_base/lib/http_base.dart
diff --git a/dart/pkg/http_base/lib/http_base.dart b/dart/pkg/http_base/lib/http_base.dart
new file mode 100644
index 0000000000000000000000000000000000000000..36c76389ca389c9375a3c606dce2d484767928b7
--- /dev/null
+++ b/dart/pkg/http_base/lib/http_base.dart
@@ -0,0 +1,132 @@
+// Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+library http_base;
+
+import 'dart:async';
+
+/**
kevmoo 2014/05/23 21:22:24 All packages are moving towards triple-slash "///"
Søren Gjesse 2014/05/26 07:12:46 In my opinion the "///" doc comments are harder to
kustermann 2014/05/26 09:12:31 If you say "All packages are moving towards triple
+ * Representation of a set of HTTP headers.
+ */
+abstract class Headers {
+ /**
+ * Returns the names of all header fields.
+ */
+ Iterable<String> get names;
+
+ /**
+ * Returns true if a header field of the specified [name] exist.
kevmoo 2014/05/23 21:22:24 `true`
kustermann 2014/05/26 09:12:31 Done.
+ */
+ bool contains(String name);
+
+ /**
+ * Returns the value for the header field named [name].
+ *
+ * The HTTP standard supports multiple values for each header field name.
+ * Header fields with multiple values can be represented as a
+ * comma-separated list. If a header has multiple values the returned string
+ * is the comma-separated list of all these values.
+ *
+ * For the 'Cookie' and 'Set-Cookie' headers the comma-separated list
kevmoo 2014/05/23 21:22:24 We should not specify an undefined behavior for a
Søren Gjesse 2014/05/26 07:12:46 If we should specify something here lets go for th
kustermann 2014/05/26 09:12:31 Done.
+ * representation does not work, and for these headers using this method is
+ * undefined. Use the `getMultiple` method for these headers.
+ */
+ String operator [](String name);
+
+ /**
+ * Returns the values for the header field named [name].
+ *
+ * The order in which the values for the field name appear is the same
+ * as the order in which they are to be send or was received.
+ */
+ Iterable<String> getMultiple(String name);
+}
+
+
+/**
+ * Representation of a HTTP request.
+ */
+abstract class Request {
+ /**
+ * Request method.
+ */
+ String get method;
+
+ /**
+ * Request url.
+ */
+ Uri get url;
+
+ /**
+ * Request headers.
+ */
+ Headers get headers;
+
+ /**
+ * Request body.
+ */
+ Stream<List<int>> get body;
kevmoo 2014/05/23 21:22:24 Use a method here: read() In many cases, the body
kustermann 2014/05/26 09:12:31 Done.
kustermann 2014/05/26 09:12:31 Done.
+}
+
+
+/**
+ * Representation of a HTTP response.
+ */
+abstract class Response {
+ /**
+ * Response status code.
+ */
+ int get statusCode;
Søren Gjesse 2014/05/26 07:12:46 If we remove reasonPhrase lets change this to just
kustermann 2014/05/26 09:12:31 Done.
kustermann 2014/05/26 09:12:31 Done.
+
+ /**
+ * Response reason phrase.
+ */
+ String get reasonPhrase;
kevmoo 2014/05/23 21:22:24 Can we skip this? It's not supported in HTTP 2.0
Søren Gjesse 2014/05/26 07:12:46 I am OK with that - I does not add much value. Th
kustermann 2014/05/26 09:12:31 Removed.
+
+ /**
+ * Response headers.
+ */
+ Headers get headers;
+
+ /**
+ * Response body.
+ */
+ Stream<List<int>> get body;
kevmoo 2014/05/23 21:22:24 read() here, too. Same as above.
kustermann 2014/05/26 09:12:31 Done.
+}
+
+
+
+/**
+ * Function for performing an http request.
Søren Gjesse 2014/05/23 12:25:30 http -> HTTP Here is says 'an HTTP', and other pl
kustermann 2014/05/26 09:12:31 Done.
+ *
+ * The [HttpClient] may use any transport mechanism it wants
+ * (e.g. HTTP/1.1, HTTP/2.0, SPDY) to perform the http request.
+ *
+ * [HttpClient]s are composable. E.g. A [HttpClient] may add an
+ * 'Authorization' header to [request] and forward to another [HttpClient].
+ *
+ * A [HttpClient] handler may ignore connection specific headers in [request]
+ * and may not present them in the [Response] object.
+ *
+ * Connection specific headers:
+ * 'Connection', 'Upgrade', 'Keep-Alive', 'Transfer-Encoding'
+ *
+ */
+typedef Future<Response> HttpClient(Request request);
kevmoo 2014/05/23 21:22:24 We must not export two identical typedefs. Not wor
kevmoo 2014/05/23 21:22:24 There is already an HttpClient in dart:io. We DON'
kevmoo 2014/05/23 22:07:05 Requester?
Søren Gjesse 2014/05/26 07:12:46 I agree that this can be confusing. However the "c
kustermann 2014/05/26 09:12:31 Removed the prefix, users should use prefix import
+
+/**
+ * Function for handling an http request.
Søren Gjesse 2014/05/23 12:25:30 http -> HTTP
kustermann 2014/05/26 09:12:31 Done.
kustermann 2014/05/26 09:12:31 Done.
+ *
+ * The [HttpRequestHandler] should not react on any connection specific headers
+ * in [request] and connection specific headers in it's [Response] may be
+ * ignored by an Http Server.
Søren Gjesse 2014/05/23 12:25:30 Http -> HTTP
kustermann 2014/05/26 09:12:31 Done.
kustermann 2014/05/26 09:12:31 Done.
+ *
+ * [HttpRequestHandler]s are composable. E.g. A [HttpRequestHandler] may call
+ * another [HttpRequestHandler] and augment the headers with a 'Set-Cookie'
Søren Gjesse 2014/05/23 12:25:30 with -> with e.g.
kustermann 2014/05/26 09:12:31 Done.
kustermann 2014/05/26 09:12:31 Done.
+ * header.
+ *
+ * Connection specific headers:
+ * 'Connection', 'Upgrade', 'Keep-Alive', 'Transfer-Encoding'
+ */
+typedef Future<Response> HttpRequestHandler(Request request);
kevmoo 2014/05/23 22:07:05 Eliminate this typedef. We only have confusion if
kustermann 2014/05/26 09:12:31 Not done. See above.

Powered by Google App Engine
This is Rietveld 408576698