Skip to content

Commit

Permalink
link to API docs in rubydoc.info
Browse files Browse the repository at this point in the history
  • Loading branch information
igrigorik committed Sep 25, 2013
1 parent c5e52c0 commit 56a89ba
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Expand Up @@ -10,7 +10,8 @@ Pure ruby, framework and transport agnostic implementation of [HTTP 2.0 protocol
* [Stream multiplexing](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_STREAMS_MESSAGES_FRAMES) and [prioritization](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PRIORITIZATION)
* Connection and stream [flow control](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#_flow_control)
* [Header compression](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_HEADER_COMPRESSION) and [server push](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PUSH)
* Connection and stream management, and other HTTP 2.0 goodies...
* Connection and stream management
* And more... see [API docs](http://www.rubydoc.info/github/igrigorik/http-2/frames)

Current implementation (see [HPBN chapter for HTTP 2.0 overview](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html)), is based on:

Expand Down Expand Up @@ -47,7 +48,7 @@ Checkout provided [client](https://github.com/igrigorik/http-2/blob/master/examp

### Connection lifecycle management

When the connection object is instantiated you must specify its role (`:client` or `:server`) to initialize appropriate header compression / decompression algorithms and stream management logic. From there, you can subscribe to connection level events, or invoke appropriate APIs to allocate new streams and manage the lifecycle. For example:
When the [Connection object](http://www.rubydoc.info/github/igrigorik/http-2/HTTP2/Connection) is instantiated you must specify its role (`:client` or `:server`) to initialize appropriate header compression / decompression algorithms and stream management logic. From there, you can subscribe to connection level events, or invoke appropriate APIs to allocate new streams and manage the lifecycle. For example:

```ruby
# - Server ---------------
Expand Down Expand Up @@ -150,7 +151,7 @@ conn.on(:stream) do |stream|
end
```

Events emitted by the stream object:
Events emitted by the [Stream object](http://www.rubydoc.info/github/igrigorik/http-2/HTTP2/Stream):

<table>
<tr>
Expand Down

0 comments on commit 56a89ba

Please sign in to comment.