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

Unified Diff: pkg/http_server/README.md

Issue 32003002: Add README file for http_server package. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Cleanup. Created 7 years, 2 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
« no previous file with comments | « no previous file | pkg/http_server/pubspec.yaml » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/http_server/README.md
diff --git a/pkg/http_server/README.md b/pkg/http_server/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..8653f9f492ab30f4693d4e0453d4a919c8bf9e5e
--- /dev/null
+++ b/pkg/http_server/README.md
@@ -0,0 +1,44 @@
+Library of HTTP server classes.
+
+This package contains a set of high-level classes that, together with
+HttpServer, makes is easy to provide content through HTTP servers.
+
+## Virtual Directory
+
+The VirtualDirectory class makes it possible to easy serve static content from
+the drive. It supports:
+
+ * Range-based request, making it possible to pause/resume downloads and stream
+ videos.
+ * If-Modified-Since based caching.
+ * Automatic GZip-compression of content.
+ * Ability to follow links within, either throughout the system or in a jailed
+ root.
+ * Optional directory listing.
+
+ The following example shows how to set up a Virtual Directory of a given path
+
+ var virtualDirectory = new VirtualDirectory('/var/www/');
+ virtualDirectory.serve(new HttpServer('0.0.0.0', 8080));
+
+See [VirtualDirectory](
+http://api.dartlang.org/docs/http_server/VirtualDirectory.html)
+for more info about how to customize the class.
+
+## Virtual Host
+
+The VirtualHost class makes it possible to serve multiple hosts on the same
+address, by using the `Host` field of the incoming requests. It also provides
+the ability to work on wildcards for sub-domains.
+
+ var virtualHost = new VirtualHost(server);
+ // Filter out on a specific host
+ var stream1 = virtualServer.addHost('static.myserver.com');
+ // Wildcard for any other sub-domains.
+ var stream2 = virtualServer.addHost('*.myserver.com');
+ // Requets not matching any hosts.
+ var stream3 = virtualServer.unhandled;
+
+See [VirtualHost](
+http://api.dartlang.org/docs/http_server/VirtualHost.html)
+for more information.
« no previous file with comments | « no previous file | pkg/http_server/pubspec.yaml » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698