Class: Vertx::HttpServerRequest
- Inherits:
-
Object
- Object
- Vertx::HttpServerRequest
- Includes:
- ReadStream
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb
Overview
Instances are created for each request and passed to the user via a handler.
Each instance of this class is associated with a corresponding HttpServerResponse instance via #response.
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)
-
- (String) absolute_uri
The absolute URI corresponding to the the HTTP request.
-
- (self) body_handler { ... }
Convenience method for receiving the entire request body in one piece.
-
- (::Vertx::HttpConnection) connection
The HttpConnection associated with this request.
-
- (self) custom_frame_handler { ... }
Set a custom frame handler.
- - (self) end_handler { ... }
-
- (true, false) ended?
Has the request ended? I.e.
- - (self) exception_handler { ... }
-
- (true, false) expect_multipart?
True if we are expecting a multi-part body for this request.
-
- (::Vertx::MultiMap) form_attributes
Returns a map of all form attributes in the request.
-
- (String) get_form_attribute(attributeName = nil)
Return the first form attribute value with the specified name.
-
- (String) get_header(headerName = nil)
Return the first header value with the specified name.
-
- (String) get_param(paramName = nil)
Return the first param value with the specified name.
- - (self) handler { ... }
-
- (::Vertx::MultiMap) headers
The headers in the request.
-
- (String) host
The request host.
-
- (::Vertx::SocketAddress) local_address
The local (server side) address of the server that handles the request.
-
- (:OPTIONS, ...) method
The HTTP method for the request.
-
- (::Vertx::NetSocket) net_socket
Get a net socket for the underlying connection of this request.
-
- (::Vertx::MultiMap) params
The query parameters in the request.
-
- (String) path
The path part of the uri.
- - (self) pause
-
- (String) query
The query part of the uri.
-
- (String) raw_method
The HTTP method as sent by the client.
-
- (::Vertx::SocketAddress) remote_address
The remote (client side) address of the request.
-
- (::Vertx::HttpServerResponse) response
The response.
- - (self) resume
-
- (String) scheme
The scheme of the request.
-
- (self) set_expect_multipart(expect = nil)
Call this with true if you are expecting a multi-part body to be submitted in the request.
-
- (true, false) ssl?
True if this NetSocket is encrypted via SSL/TLS.
-
- (::Vertx::ServerWebSocket) upgrade
Upgrade the connection to a WebSocket connection.
-
- (self) upload_handler { ... }
Set an upload handler.
-
- (String) uri
The URI of the request.
-
- (:HTTP_1_0, ...) version
The HTTP version of the request.
Class Method Details
+ (Boolean) accept?(obj)
36 37 38 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 36 def @@j_api_type.accept?(obj) obj.class == HttpServerRequest end |
+ (Object) j_api_type
45 46 47 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 45 def self.j_api_type @@j_api_type end |
+ (Object) j_class
48 49 50 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 48 def self.j_class Java::IoVertxCoreHttp::HttpServerRequest.java_class end |
+ (Object) unwrap(obj)
42 43 44 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 42 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
39 40 41 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 39 def @@j_api_type.wrap(obj) HttpServerRequest.new(obj) end |
Instance Method Details
- (String) absolute_uri
226 227 228 229 230 231 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 226 def absolute_uri if !block_given? return @j_del.java_method(:absoluteURI, []).call() end raise ArgumentError, "Invalid arguments when calling absolute_uri()" end |
- (self) body_handler { ... }
This saves the user having to manually setting a data and end handler 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.
238 239 240 241 242 243 244 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 238 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 |
- (::Vertx::HttpConnection) connection
347 348 349 350 351 352 353 354 355 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 347 def connection if !block_given? if @cached_connection != nil return @cached_connection end return @cached_connection = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:connection, []).call(),::Vertx::HttpConnection) end raise ArgumentError, "Invalid arguments when calling connection()" end |
- (self) custom_frame_handler { ... }
339 340 341 342 343 344 345 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 339 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 { ... }
87 88 89 90 91 92 93 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 87 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 |
- (true, false) ended?
329 330 331 332 333 334 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 329 def ended? if !block_given? return @j_del.java_method(:isEnded, []).call() end raise ArgumentError, "Invalid arguments when calling ended?()" end |
- (self) exception_handler { ... }
53 54 55 56 57 58 59 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 53 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 |
- (true, false) expect_multipart?
274 275 276 277 278 279 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 274 def expect_multipart? if !block_given? return @j_del.java_method(:isExpectMultipart, []).call() end raise ArgumentError, "Invalid arguments when calling expect_multipart?()" end |
- (::Vertx::MultiMap) form_attributes
Be aware that the attributes will only be available after the whole body has been received, i.e. after the request end handler has been called.
#set_expect_multipart must be called first before trying to get the form attributes.
298 299 300 301 302 303 304 305 306 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 298 def form_attributes if !block_given? if @cached_form_attributes != nil return @cached_form_attributes end return @cached_form_attributes = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:formAttributes, []).call(),::Vertx::MultiMap) end raise ArgumentError, "Invalid arguments when calling form_attributes()" end |
- (String) get_form_attribute(attributeName = nil)
310 311 312 313 314 315 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 310 def get_form_attribute(attributeName=nil) if attributeName.class == String && !block_given? return @j_del.java_method(:getFormAttribute, [Java::java.lang.String.java_class]).call(attributeName) end raise ArgumentError, "Invalid arguments when calling get_form_attribute(#{attributeName})" end |
- (String) get_header(headerName = nil)
180 181 182 183 184 185 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 180 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_param(paramName = nil)
199 200 201 202 203 204 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 199 def get_param(paramName=nil) if paramName.class == String && !block_given? return @j_del.java_method(:getParam, [Java::java.lang.String.java_class]).call(paramName) end raise ArgumentError, "Invalid arguments when calling get_param(#{paramName})" end |
- (self) handler { ... }
62 63 64 65 66 67 68 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 62 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
168 169 170 171 172 173 174 175 176 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 168 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 |
- (String) host
151 152 153 154 155 156 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 151 def host if !block_given? return @j_del.java_method(:host, []).call() end raise ArgumentError, "Invalid arguments when calling host()" end |
- (::Vertx::SocketAddress) local_address
216 217 218 219 220 221 222 223 224 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 216 def local_address if !block_given? if @cached_local_address != nil return @cached_local_address end return @cached_local_address = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:localAddress, []).call(),::Vertx::SocketAddress) end raise ArgumentError, "Invalid arguments when calling local_address()" end |
- (:OPTIONS, ...) method
102 103 104 105 106 107 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 102 def method if !block_given? return @j_del.java_method(:method, []).call().name.intern end raise ArgumentError, "Invalid arguments when calling method()" end |
- (::Vertx::NetSocket) net_socket
USE THIS WITH CAUTION!
Once you have called this method, you must handle writing to the connection yourself using the net socket, the server request instance will no longer be usable as normal. Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.
253 254 255 256 257 258 259 260 261 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 253 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 |
- (::Vertx::MultiMap) params
187 188 189 190 191 192 193 194 195 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 187 def params if !block_given? if @cached_params != nil return @cached_params end return @cached_params = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:params, []).call(),::Vertx::MultiMap) end raise ArgumentError, "Invalid arguments when calling params()" end |
- (String) path
137 138 139 140 141 142 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 137 def path if !block_given? return @j_del.java_method(:path, []).call() end raise ArgumentError, "Invalid arguments when calling path()" end |
- (self) pause
70 71 72 73 74 75 76 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 70 def pause if !block_given? @j_del.java_method(:pause, []).call() return self end raise ArgumentError, "Invalid arguments when calling pause()" end |
- (String) query
144 145 146 147 148 149 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 144 def query if !block_given? return @j_del.java_method(:query, []).call() end raise ArgumentError, "Invalid arguments when calling query()" end |
- (String) raw_method
109 110 111 112 113 114 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 109 def raw_method if !block_given? return @j_del.java_method(:rawMethod, []).call() end raise ArgumentError, "Invalid arguments when calling raw_method()" end |
- (::Vertx::SocketAddress) remote_address
206 207 208 209 210 211 212 213 214 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 206 def remote_address if !block_given? if @cached_remote_address != nil return @cached_remote_address end return @cached_remote_address = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:remoteAddress, []).call(),::Vertx::SocketAddress) end raise ArgumentError, "Invalid arguments when calling remote_address()" end |
- (::Vertx::HttpServerResponse) response
158 159 160 161 162 163 164 165 166 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 158 def response if !block_given? if @cached_response != nil return @cached_response end return @cached_response = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:response, []).call(),::Vertx::HttpServerResponse) end raise ArgumentError, "Invalid arguments when calling response()" end |
- (self) resume
78 79 80 81 82 83 84 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 78 def resume if !block_given? @j_del.java_method(:resume, []).call() return self end raise ArgumentError, "Invalid arguments when calling resume()" end |
- (String) scheme
123 124 125 126 127 128 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 123 def scheme if !block_given? return @j_del.java_method(:scheme, []).call() end raise ArgumentError, "Invalid arguments when calling scheme()" end |
- (self) set_expect_multipart(expect = nil)
266 267 268 269 270 271 272 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 266 def set_expect_multipart(expect=nil) if (expect.class == TrueClass || expect.class == FalseClass) && !block_given? @j_del.java_method(:setExpectMultipart, [Java::boolean.java_class]).call(expect) return self end raise ArgumentError, "Invalid arguments when calling set_expect_multipart(#{expect})" end |
- (true, false) ssl?
116 117 118 119 120 121 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 116 def ssl? if !block_given? return @j_del.java_method(:isSSL, []).call() end raise ArgumentError, "Invalid arguments when calling ssl?()" end |
- (::Vertx::ServerWebSocket) upgrade
This is an alternative way of handling WebSockets and can only be used if no websocket handlers are set on the Http server, and can only be used during the upgrade request during the WebSocket handshake.
321 322 323 324 325 326 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 321 def upgrade if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:upgrade, []).call(),::Vertx::ServerWebSocket) end raise ArgumentError, "Invalid arguments when calling upgrade()" end |
- (self) upload_handler { ... }
284 285 286 287 288 289 290 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 284 def upload_handler if block_given? @j_del.java_method(:uploadHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpServerFileUpload)) })) return self end raise ArgumentError, "Invalid arguments when calling upload_handler()" end |
- (String) uri
130 131 132 133 134 135 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 130 def uri if !block_given? return @j_del.java_method(:uri, []).call() end raise ArgumentError, "Invalid arguments when calling uri()" end |
- (:HTTP_1_0, ...) version
95 96 97 98 99 100 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server_request.rb', line 95 def version if !block_given? return @j_del.java_method(:version, []).call().name.intern end raise ArgumentError, "Invalid arguments when calling version()" end |