Class: Vertx::HttpServer
- Inherits:
-
Object
- Object
- Vertx::HttpServer
- Includes:
- Measured
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb
Overview
An HTTP and WebSockets server.
You receive HTTP requests by providing a #request_handler. As requests arrive on the server the handler will be called with the requests.
You receive WebSockets by providing a #websocket_handler. As WebSocket connections arrive on the server, the WebSocket is passed to the handler.
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)
-
- (Fixnum) actual_port
The actual port the server is listening on.
-
- (void) close { ... }
Like #close but supplying a handler that will be called when the server is actually closed (or has failed).
-
- (self) connection_handler { ... }
Set a connection handler for the server.
-
- (self) listen(port = nil, host = nil) { ... }
Like #listen but supplying a handler that will be called when the server is actually listening (or has failed).
-
- (true, false) metrics_enabled?
Whether the metrics are enabled for this measured object.
-
- (self) request_handler { ... }
Set the request handler for the server to requestHandler.
-
- (::Vertx::ReadStream) request_stream
Return the request stream for the server.
-
- (self) websocket_handler { ... }
Set the websocket handler for the server to wsHandler.
-
- (::Vertx::ReadStream) websocket_stream
Return the websocket stream for the server.
Class Method Details
+ (Boolean) accept?(obj)
29 30 31 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 29 def @@j_api_type.accept?(obj) obj.class == HttpServer end |
+ (Object) j_api_type
38 39 40 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 38 def self.j_api_type @@j_api_type end |
+ (Object) j_class
41 42 43 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 41 def self.j_class Java::IoVertxCoreHttp::HttpServer.java_class end |
+ (Object) unwrap(obj)
35 36 37 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 35 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
32 33 34 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 32 def @@j_api_type.wrap(obj) HttpServer.new(obj) end |
Instance Method Details
- (Fixnum) actual_port
The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number
signifying an ephemeral port
150 151 152 153 154 155 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 150 def actual_port if !block_given? return @j_del.java_method(:actualPort, []).call() end raise ArgumentError, "Invalid arguments when calling actual_port()" end |
- (void) close { ... }
This method returns an undefined value.
Like #close but supplying a handler that will be called when the server is actually closed (or has failed).
139 140 141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 139 def close if !block_given? return @j_del.java_method(:close, []).call() elsif block_given? return @j_del.java_method(:close, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) })) end raise ArgumentError, "Invalid arguments when calling close()" end |
- (self) connection_handler { ... }
Set a connection handler for the server.
78 79 80 81 82 83 84 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 78 def connection_handler if block_given? @j_del.java_method(:connectionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpConnection)) })) return self end raise ArgumentError, "Invalid arguments when calling connection_handler()" end |
- (self) listen(port = nil, host = nil) { ... }
Like #listen but supplying a handler that will be called when the server is actually
listening (or has failed).
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 114 def listen(port=nil,host=nil) if !block_given? && port == nil && host == nil @j_del.java_method(:listen, []).call() return self elsif port.class == Fixnum && !block_given? && host == nil @j_del.java_method(:listen, [Java::int.java_class]).call(port) return self elsif block_given? && port == nil && host == nil @j_del.java_method(:listen, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::HttpServer) : nil) })) return self elsif port.class == Fixnum && host.class == String && !block_given? @j_del.java_method(:listen, [Java::int.java_class,Java::java.lang.String.java_class]).call(port,host) return self elsif port.class == Fixnum && block_given? && host == nil @j_del.java_method(:listen, [Java::int.java_class,Java::IoVertxCore::Handler.java_class]).call(port,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::HttpServer) : nil) })) return self elsif port.class == Fixnum && host.class == String && block_given? @j_del.java_method(:listen, [Java::int.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(port,host,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::Vertx::HttpServer) : nil) })) return self end raise ArgumentError, "Invalid arguments when calling listen(#{port},#{host})" end |
- (true, false) metrics_enabled?
Whether the metrics are enabled for this measured object
46 47 48 49 50 51 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 46 def metrics_enabled? if !block_given? return @j_del.java_method(:isMetricsEnabled, []).call() end raise ArgumentError, "Invalid arguments when calling metrics_enabled?()" end |
- (self) request_handler { ... }
Set the request handler for the server to
requestHandler
. As HTTP requests are received by the server,
instances of Vertx::HttpServerRequest will be created and passed to this handler.
68 69 70 71 72 73 74 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 68 def request_handler if block_given? @j_del.java_method(:requestHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::HttpServerRequest)) })) return self end raise ArgumentError, "Invalid arguments when calling request_handler()" end |
- (::Vertx::ReadStream) request_stream
Return the request stream for the server. As HTTP requests are received by the server,
instances of Vertx::HttpServerRequest will be created and passed to the stream .
55 56 57 58 59 60 61 62 63 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 55 def request_stream if !block_given? if @cached_request_stream != nil return @cached_request_stream end return @cached_request_stream = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:requestStream, []).call(),::Vertx::ReadStreamImpl,::Vertx::HttpServerRequest.j_api_type) end raise ArgumentError, "Invalid arguments when calling request_stream()" end |
- (self) websocket_handler { ... }
Set the websocket handler for the server to
wsHandler
. If a websocket connect handshake is successful a
new ServerWebSocket instance will be created and passed to the handler.
101 102 103 104 105 106 107 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 101 def websocket_handler if block_given? @j_del.java_method(:websocketHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::ServerWebSocket)) })) return self end raise ArgumentError, "Invalid arguments when calling websocket_handler()" end |
- (::Vertx::ReadStream) websocket_stream
Return the websocket stream for the server. If a websocket connect handshake is successful a
new ServerWebSocket instance will be created and passed to the stream .
88 89 90 91 92 93 94 95 96 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 88 def websocket_stream if !block_given? if @cached_websocket_stream != nil return @cached_websocket_stream end return @cached_websocket_stream = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:websocketStream, []).call(),::Vertx::ReadStreamImpl,::Vertx::ServerWebSocket.j_api_type) end raise ArgumentError, "Invalid arguments when calling websocket_stream()" end |