Documentation run on schemes/ipd. (#18)

* Documentation run on schemes/ipd.

* Update main.rs

* Update resource.rs
This commit is contained in:
David Teller 2016-10-24 15:40:44 +02:00 • committed by Jeremy Soller
commit 35696f4169

View file

@ -1,5 +1,24 @@
#![feature(rand)]
//! Implementation of the IP Scheme as a userland driver.
//!
//! # Role
//!
//! See https://en.wikipedia.org/wiki/Internet_Protocol for more details about the
//! IP protocol. Clients will often prefer using either higher-level protocols TCP
//! or UDP, both of which are built upon IP.
//!
//! # URL Syntax
//!
//! To open a IP connection, use `ip:[host]/protocol`.
//!
//! * If `host` is specified, it must be an ipv4 number (e.g. `192.168.0.1`)
//! and the connection may be used immediately to send/receive data.
//! * If `host` is omitted, this connectino will wait for a distant peer to
//! connect.
//! * The `protocol` is the hex-based number of the ip protocol
//! (see http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
extern crate netutils;
extern crate resource_scheme;
extern crate syscall;