Browse files

Add more resource_task docs

  • Loading branch information...
1 parent 08789e5 commit f2c97474c5e2acdf52e6dff1d56d1867efb6f050 @brson brson committed Jul 28, 2012
Showing with 13 additions and 1 deletion.
  1. +13 −1 src/servo/resource/resource_task.rs
View
14 src/servo/resource/resource_task.rs
@@ -15,19 +15,31 @@ import std::net::url::url;
import result::{result, ok, err};
enum ControlMsg {
+ /// Request the data associated with a particular URL
Load(url, chan<ProgressMsg>),
Exit
}
+/// Messages sent in response to a `Load` message
enum ProgressMsg {
+ /// Binary data - there may be multiple of these
Payload(~[u8]),
+ /// Indicates loading is complete, either successfully or not
Done(result<(), ()>)
}
+/// Handle to a resource task
type ResourceTask = chan<ControlMsg>;
-/// Creates a task to load a specific resource
+
+/**
+Creates a task to load a specific resource
+
+The ResourceManager delegates loading to a different type of loader task for
+each URL scheme
+*/
type LoaderTaskFactory = fn~(url: url, chan<ProgressMsg>);
+/// Create a ResourceTask with the default loaders
fn ResourceTask() -> ResourceTask {
let loaders = ~[
(~"file", file_loader::factory),

0 comments on commit f2c9747

Please sign in to comment.