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.
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::HttpServerRequestStream) request_stream
Return the request stream for the server.
-
- (self) websocket_handler { ... }
Set the websocket handler for the server to wsHandler.
-
- (::Vertx::ServerWebSocketStream) websocket_stream
Return the websocket stream for the server.
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
135 136 137 138 139 140 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 135 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).
124 125 126 127 128 129 130 131 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 124 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.
63 64 65 66 67 68 69 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 63 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).
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 99 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
31 32 33 34 35 36 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 31 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.
53 54 55 56 57 58 59 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 53 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::HttpServerRequestStream) 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 .
40 41 42 43 44 45 46 47 48 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 40 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::HttpServerRequestStream) 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.
86 87 88 89 90 91 92 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 86 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::ServerWebSocketStream) 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 .
73 74 75 76 77 78 79 80 81 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/http_server.rb', line 73 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::ServerWebSocketStream) end raise ArgumentError, "Invalid arguments when calling websocket_stream()" end |