diff --git a/README.md b/README.md index 1b16f89..dd409c1 100644 --- a/README.md +++ b/README.md @@ -216,13 +216,13 @@ The host is assigned the hardware address `02-00-00-00-00-02` and IPv4 address ` Read its [source code](/examples/httpclient.rs), then run it as: ```sh -cargo run --example client -- tap0 ADDRESS URL +cargo run --example httpclient -- tap0 ADDRESS URL ``` For example: ```sh -cargo run --example client -- tap0 93.184.216.34 http://example.org/ +cargo run --example httpclient -- tap0 93.184.216.34 http://example.org/ ``` It connects to the given address (not a hostname) and URL, and prints any returned response data. diff --git a/src/socket/tcp.rs b/src/socket/tcp.rs index a5bbcf7..52e14e1 100644 --- a/src/socket/tcp.rs +++ b/src/socket/tcp.rs @@ -10,6 +10,7 @@ use wire::{IpProtocol, IpRepr, IpAddress, IpEndpoint, TcpSeqNumber, TcpRepr, Tcp use socket::{Socket, SocketMeta, SocketHandle}; use storage::{Assembler, RingBuffer}; +/// A TCP socket ring buffer. pub type SocketBuffer<'a> = RingBuffer<'a, u8>; /// The state of a TCP socket, according to [RFC 793][rfc793].