diff options
author | Kazuki Yamaguchi <k@rhe.jp> | 2015-10-25 23:44:05 +0900 |
---|---|---|
committer | Kazuki Yamaguchi <k@rhe.jp> | 2015-10-25 23:44:05 +0900 |
commit | baf217cf0ed4eb5990d7823903a152d0c337c377 (patch) | |
tree | 2ddf447357d9b106ca7e0a9a3f9e9c2c97e6c599 /lib/plum/stream_utils.rb | |
parent | e14480d588bfc6182fab7b9ed7292c317b36a752 (diff) | |
download | plum-baf217cf0ed4eb5990d7823903a152d0c337c377.tar.gz |
improve docs
Diffstat (limited to 'lib/plum/stream_utils.rb')
-rw-r--r-- | lib/plum/stream_utils.rb | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/lib/plum/stream_utils.rb b/lib/plum/stream_utils.rb index 44ed945..eede307 100644 --- a/lib/plum/stream_utils.rb +++ b/lib/plum/stream_utils.rb @@ -3,7 +3,6 @@ using Plum::BinaryString module Plum module StreamUtils # Responds to a HTTP request. - # # @param headers [Enumerable<String, String>] The response headers. # @param body [String, IO] The response body. def respond(headers, body = nil, end_stream: true) # TODO: priority, padding @@ -16,7 +15,6 @@ module Plum end # Reserves a stream to server push. Sends PUSH_PROMISE and create new stream. - # # @param headers [Enumerable<String, String>] The *request* headers. It must contain all of them: ':authority', ':method', ':scheme' and ':path'. # @return [Stream] The stream to send push response. def promise(headers) @@ -30,7 +28,6 @@ module Plum end # Sends response headers. If the encoded frame is larger than MAX_FRAME_SIZE, the headers will be splitted into HEADERS frame and CONTINUATION frame(s). - # # @param headers [Enumerable<String, String>] The response headers. # @param end_stream [Boolean] Set END_STREAM flag or not. def send_headers(headers, end_stream:) @@ -44,7 +41,6 @@ module Plum end # Sends DATA frame. If the data is larger than MAX_FRAME_SIZE, DATA frame will be splitted. - # # @param data [String, IO] The data to send. # @param end_stream [Boolean] Set END_STREAM flag or not. def send_data(data, end_stream: true) |