Class: Vertx::HttpClientResponse
- Inherits:
-
Object
- Object
- Vertx::HttpClientResponse
- Includes:
- ReadStream
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb
Overview
Vert.x provides you with one of these via the handler that was provided when creating the HttpClientRequest or that was set on the HttpClientRequest instance.
It implements ReadStream so it can be used with Pump to pump data with flow control.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (self) body_handler { ... }
Convenience method for receiving the entire request body in one piece.
-
- (Array<String>) cookies
The Set-Cookie headers (including trailers).
-
- (self) custom_frame_handler { ... }
Set an custom frame handler.
- - (self) end_handler { ... }
- - (self) exception_handler { ... }
-
- (String) get_header(headerName = nil)
Return the first header value with the specified name.
-
- (String) get_trailer(trailerName = nil)
Return the first trailer value with the specified name.
- - (self) handler { ... }
-
- (::Vertx::MultiMap) headers
The headers.
-
- (::Vertx::NetSocket) net_socket
Get a net socket for the underlying connection of this request.
- - (self) pause
-
- (::Vertx::HttpClientRequest) request
The corresponding request.
- - (self) resume
-
- (Fixnum) status_code
The status code of the response.
-
- (String) status_message
The status message of the response.
-
- (::Vertx::MultiMap) trailers
The trailers.
-
- (:HTTP_1_0, ...) version
The version of the response.
Class Method Details
+ (Boolean) accept?(obj)
30 31 32 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 30 def @@j_api_type.accept?(obj) obj.class == HttpClientResponse end |
+ (Object) j_api_type
39 40 41 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 39 def self.j_api_type @@j_api_type end |
+ (Object) j_class
42 43 44 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 42 def self.j_class Java::IoVertxCoreHttp::HttpClientResponse.java_class end |
+ (Object) unwrap(obj)
36 37 38 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 36 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
33 34 35 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 33 def @@j_api_type.wrap(obj) HttpClientResponse.new(obj) end |
Instance Method Details
- (self) body_handler { ... }
This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.
163 164 165 166 167 168 169 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 163 def body_handler if block_given? @j_del.java_method(:bodyHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) })) return self end raise ArgumentError, "Invalid arguments when calling body_handler()" end |
- (Array<String>) cookies
148 149 150 151 152 153 154 155 156 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 148 def if !block_given? if @cached_cookies != nil return @cached_cookies end return @cached_cookies = @j_del.java_method(:cookies, []).call().to_a.map { |elt| elt } end raise ArgumentError, "Invalid arguments when calling cookies()" end |
- (self) custom_frame_handler { ... }
174 175 176 177 178 179 180 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 174 def custom_frame_handler if block_given? @j_del.java_method(:customFrameHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpFrame)) })) return self end raise ArgumentError, "Invalid arguments when calling custom_frame_handler()" end |
- (self) end_handler { ... }
81 82 83 84 85 86 87 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 81 def end_handler if block_given? @j_del.java_method(:endHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield }) return self end raise ArgumentError, "Invalid arguments when calling end_handler()" end |
- (self) exception_handler { ... }
55 56 57 58 59 60 61 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 55 def exception_handler if block_given? @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) })) return self end raise ArgumentError, "Invalid arguments when calling exception_handler()" end |
- (String) get_header(headerName = nil)
122 123 124 125 126 127 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 122 def get_header(headerName=nil) if headerName.class == String && !block_given? return @j_del.java_method(:getHeader, [Java::java.lang.String.java_class]).call(headerName) end raise ArgumentError, "Invalid arguments when calling get_header(#{headerName})" end |
- (String) get_trailer(trailerName = nil)
131 132 133 134 135 136 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 131 def get_trailer(trailerName=nil) if trailerName.class == String && !block_given? return @j_del.java_method(:getTrailer, [Java::java.lang.String.java_class]).call(trailerName) end raise ArgumentError, "Invalid arguments when calling get_trailer(#{trailerName})" end |
- (self) handler { ... }
64 65 66 67 68 69 70 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 64 def handler if block_given? @j_del.java_method(:handler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) })) return self end raise ArgumentError, "Invalid arguments when calling handler()" end |
- (::Vertx::MultiMap) headers
110 111 112 113 114 115 116 117 118 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 110 def headers if !block_given? if @cached_headers != nil return @cached_headers end return @cached_headers = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:headers, []).call(),::Vertx::MultiMap) end raise ArgumentError, "Invalid arguments when calling headers()" end |
- (::Vertx::NetSocket) net_socket
USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol
One valid use-case for calling this is to receive the NetSocket after a HTTP CONNECT was issued to the remote peer and it responded with a status code of 200.
188 189 190 191 192 193 194 195 196 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 188 def net_socket if !block_given? if @cached_net_socket != nil return @cached_net_socket end return @cached_net_socket = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:netSocket, []).call(),::Vertx::NetSocket) end raise ArgumentError, "Invalid arguments when calling net_socket()" end |
- (self) pause
72 73 74 75 76 77 78 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 72 def pause if !block_given? @j_del.java_method(:pause, []).call() return self end raise ArgumentError, "Invalid arguments when calling pause()" end |
- (::Vertx::HttpClientRequest) request
198 199 200 201 202 203 204 205 206 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 198 def request if !block_given? if @cached_request != nil return @cached_request end return @cached_request = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:request, []).call(),::Vertx::HttpClientRequest) end raise ArgumentError, "Invalid arguments when calling request()" end |
- (self) resume
46 47 48 49 50 51 52 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 46 def resume if !block_given? @j_del.java_method(:resume, []).call() return self end raise ArgumentError, "Invalid arguments when calling resume()" end |
- (Fixnum) status_code
96 97 98 99 100 101 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 96 def status_code if !block_given? return @j_del.java_method(:statusCode, []).call() end raise ArgumentError, "Invalid arguments when calling status_code()" end |
- (String) status_message
103 104 105 106 107 108 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 103 def if !block_given? return @j_del.java_method(:statusMessage, []).call() end raise ArgumentError, "Invalid arguments when calling status_message()" end |
- (::Vertx::MultiMap) trailers
138 139 140 141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 138 def trailers if !block_given? if @cached_trailers != nil return @cached_trailers end return @cached_trailers = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:trailers, []).call(),::Vertx::MultiMap) end raise ArgumentError, "Invalid arguments when calling trailers()" end |
- (:HTTP_1_0, ...) version
89 90 91 92 93 94 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_client_response.rb', line 89 def version if !block_given? return @j_del.java_method(:version, []).call().name.intern end raise ArgumentError, "Invalid arguments when calling version()" end |