Class: Vertx::ServerWebSocket
- Inherits:
-
Object
- Object
- Vertx::ServerWebSocket
- Includes:
- WebSocketBase
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb
Overview
Instances of this class are passed into a HttpServer#websocket_handler or provided when a WebSocket handshake is manually {::Vertx::HttpServerRequest#upgrade}ed.
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)
-
- (void) accept
Accept the WebSocket and terminate the WebSocket handshake.
-
- (String) binary_handler_id
When a WebSocket is created it automatically registers an event handler with the event bus - the ID of that handler is given by this method.
-
- (self) binary_message_handler { ... }
Set a binary message handler on the connection.
-
- (void) close(statusCode = nil, reason = nil) { ... }
Same as but with an handler called when the operation completes.
- - (self) close_handler { ... }
-
- (true, false) closed?
true if the WebSocket is closed.
- - (self) drain_handler { ... }
-
- (void) end(data = nil) { ... }
Same as but with an handler called when the operation completes.
- - (self) end_handler { ... }
- - (self) exception_handler { ... }
- - (self) fetch(amount = nil)
- - (self) frame_handler { ... }
- - (self) handler { ... }
-
- (::Vertx::MultiMap) headers
The headers in the WebSocket handshake.
-
- (::Vertx::SocketAddress) local_address
The local address for this socket.
-
- (String) path
The WebSocket handshake path.
- - (self) pause
-
- (::Vertx::Pipe) pipe
Pause this stream and return a to transfer the elements of this stream to a destination .
-
- (void) pipe_to(dst = nil) { ... }
Pipe this ReadStream to the WriteStream.
-
- (self) pong_handler { ... }
Set a pong frame handler on the connection.
-
- (String) query
The WebSocket handshake query string.
-
- (void) reject(status = nil)
Like #reject but with a status.
-
- (::Vertx::SocketAddress) remote_address
The remote address for this socket.
- - (self) resume
-
- (void) set_handshake(future = nil)
Set an asynchronous result for the handshake, upon completion of the specified future, the WebSocket will either be.
- - (self) set_write_queue_max_size(maxSize = nil)
-
- (true, false) ssl?
True if this HttpConnection is encrypted via SSL/TLS.
-
- (String) sub_protocol
Returns the WebSocket sub protocol selected by the WebSocket handshake.
-
- (String) text_handler_id
When a WebSocket is created it automatically registers an event handler with the eventbus, the ID of that handler is given by textHandlerID.
-
- (self) text_message_handler { ... }
Set a text message handler on the connection.
- - (String) uri
-
- (void) write(data = nil) { ... }
Same as but with an handler called when the operation completes.
- - (self) write_binary_message(data = nil) { ... }
- - (self) write_final_binary_frame(data = nil) { ... }
- - (self) write_final_text_frame(text = nil) { ... }
- - (self) write_frame(frame = nil) { ... }
-
- (self) write_ping(data = nil)
Writes a ping frame to the connection.
-
- (self) write_pong(data = nil)
Writes a pong frame to the connection.
-
- (true, false) write_queue_full?
This will return true if there are more bytes in the write queue than the value set using #set_write_queue_max_size.
- - (self) write_text_message(text = nil) { ... }
Class Method Details
+ (Boolean) accept?(obj)
30 31 32 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 30 def @@j_api_type.accept?(obj) obj.class == ServerWebSocket end |
+ (Object) j_api_type
39 40 41 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 39 def self.j_api_type @@j_api_type end |
+ (Object) j_class
42 43 44 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 42 def self.j_class Java::IoVertxCoreHttp::ServerWebSocket.java_class end |
+ (Object) unwrap(obj)
36 37 38 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 36 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
33 34 35 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 33 def @@j_api_type.wrap(obj) ServerWebSocket.new(obj) end |
Instance Method Details
- (void) accept
This method returns an undefined value.
Accept the WebSocket and terminate the WebSocket handshake. This method should be called from the WebSocket handler to explicitly accept the WebSocket and terminate the WebSocket handshake.
434 435 436 437 438 439 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 434 def accept if !block_given? return @j_del.java_method(:accept, []).call() end raise ArgumentError, "Invalid arguments when calling accept()" end |
- (String) binary_handler_id
WebSocket is created it automatically registers an event handler with the event bus - the ID of that
handler is given by this method.
Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.
107 108 109 110 111 112 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 107 def binary_handler_id if !block_given? return @j_del.java_method(:binaryHandlerID, []).call() end raise ArgumentError, "Invalid arguments when calling binary_handler_id()" end |
- (self) binary_message_handler { ... }
236 237 238 239 240 241 242 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 236 def if true @j_del.java_method(:binaryMessageHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling binary_message_handler()" end |
- (void) close(statusCode = nil, reason = nil) { ... }
This method returns an undefined value.
Same as but with anhandler called when the operation completes
266 267 268 269 270 271 272 273 274 275 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 266 def close(statusCode=nil,reason=nil) if true && statusCode == nil && reason == nil return @j_del.java_method(:close, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) elsif statusCode.class == Fixnum && true && reason == nil return @j_del.java_method(:close, [Java::short.java_class,Java::IoVertxCore::Handler.java_class]).call(::Vertx::Util::Utils.to_short(statusCode),(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) elsif statusCode.class == Fixnum && reason.class == String && true return @j_del.java_method(:close, [Java::short.java_class,Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(::Vertx::Util::Utils.to_short(statusCode),reason,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling close(#{statusCode},#{reason})" end |
- (self) close_handler { ... }
382 383 384 385 386 387 388 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 382 def close_handler if true @j_del.java_method(:closeHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield unless !block_given? }) return self end raise ArgumentError, "Invalid arguments when calling close_handler()" end |
- (true, false) closed?
true if the WebSocket is closed
304 305 306 307 308 309 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 304 def closed? if !block_given? return @j_del.java_method(:isClosed, []).call() end raise ArgumentError, "Invalid arguments when calling closed?()" end |
- (self) drain_handler { ... }
373 374 375 376 377 378 379 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 373 def drain_handler if true @j_del.java_method(:drainHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield unless !block_given? }) return self end raise ArgumentError, "Invalid arguments when calling drain_handler()" end |
- (void) end(data = nil) { ... }
This method returns an undefined value.
Same as but with anhandler called when the operation completes
59 60 61 62 63 64 65 66 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 59 def end(data=nil) if true && data == nil return @j_del.java_method(:end, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) elsif data.class.method_defined?(:j_del) && true return @j_del.java_method(:end, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(data.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling end(#{data})" end |
- (self) end_handler { ... }
355 356 357 358 359 360 361 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 355 def end_handler if true @j_del.java_method(:endHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield unless !block_given? }) return self end raise ArgumentError, "Invalid arguments when calling end_handler()" end |
- (self) exception_handler { ... }
312 313 314 315 316 317 318 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 312 def exception_handler if true @j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling exception_handler()" end |
- (self) fetch(amount = nil)
346 347 348 349 350 351 352 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 346 def fetch(amount=nil) if amount.class == Fixnum && !block_given? @j_del.java_method(:fetch, [Java::long.java_class]).call(amount) return self end raise ArgumentError, "Invalid arguments when calling fetch(#{amount})" end |
- (self) frame_handler { ... }
391 392 393 394 395 396 397 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 391 def frame_handler if true @j_del.java_method(:frameHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocketFrame)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling frame_handler()" end |
- (self) handler { ... }
321 322 323 324 325 326 327 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 321 def handler if true @j_del.java_method(:handler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling handler()" end |
- (::Vertx::MultiMap) headers
420 421 422 423 424 425 426 427 428 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 420 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::SocketAddress) local_address
287 288 289 290 291 292 293 294 295 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 287 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 |
- (String) path
406 407 408 409 410 411 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 406 def path if !block_given? return @j_del.java_method(:path, []).call() end raise ArgumentError, "Invalid arguments when calling path()" end |
- (self) pause
329 330 331 332 333 334 335 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 329 def pause if !block_given? @j_del.java_method(:pause, []).call() return self end raise ArgumentError, "Invalid arguments when calling pause()" end |
- (::Vertx::Pipe) pipe
WriteStream.
79 80 81 82 83 84 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 79 def pipe if !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:pipe, []).call(),::Vertx::Pipe,::Vertx::Buffer.j_api_type) end raise ArgumentError, "Invalid arguments when calling pipe()" end |
- (void) pipe_to(dst = nil) { ... }
This method returns an undefined value.
Pipe thisReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
94 95 96 97 98 99 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 94 def pipe_to(dst=nil) if dst.class.method_defined?(:j_del) && true return @j_del.java_method(:pipeTo, [Java::IoVertxCoreStreams::WriteStream.java_class,Java::IoVertxCore::Handler.java_class]).call(dst.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling pipe_to(#{dst})" end |
- (self) pong_handler { ... }
Pong frames may be at most 125 bytes (octets).
There is no ping handler since ping frames should immediately be responded to with a pong frame with identical content
Pong frames may be received unsolicited.
254 255 256 257 258 259 260 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 254 def pong_handler if true @j_del.java_method(:pongHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::Buffer)) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling pong_handler()" end |
- (String) query
413 414 415 416 417 418 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 413 def query if !block_given? return @j_del.java_method(:query, []).call() end raise ArgumentError, "Invalid arguments when calling query()" end |
- (void) reject(status = nil)
443 444 445 446 447 448 449 450 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 443 def reject(status=nil) if !block_given? && status == nil return @j_del.java_method(:reject, []).call() elsif status.class == Fixnum && !block_given? return @j_del.java_method(:reject, [Java::int.java_class]).call(status) end raise ArgumentError, "Invalid arguments when calling reject(#{status})" end |
- (::Vertx::SocketAddress) remote_address
277 278 279 280 281 282 283 284 285 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 277 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 |
- (self) resume
337 338 339 340 341 342 343 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 337 def resume if !block_given? @j_del.java_method(:resume, []).call() return self end raise ArgumentError, "Invalid arguments when calling resume()" end |
- (void) set_handshake(future = nil)
This method returns an undefined value.
Set an asynchronous result for the handshake, upon completion of the specifiedfuture, the
WebSocket will either be
- accepted when the
futuresucceeds with the HTTP status code - rejected when the
futureis succeeds with an HTTP status code different than - rejected when the
futurefails with the HTTP status code500
future with or .
This method should be called from the WebSocket handler to explicitly set an asynchronous handshake.
Calling this method will override the future completion handler.
469 470 471 472 473 474 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 469 def set_handshake(future=nil) if future.class.method_defined?(:j_del) && !block_given? return @j_del.java_method(:setHandshake, [Java::IoVertxCore::Promise.java_class]).call(future.j_del) end raise ArgumentError, "Invalid arguments when calling set_handshake(#{future})" end |
- (self) set_write_queue_max_size(maxSize = nil)
364 365 366 367 368 369 370 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 364 def set_write_queue_max_size(maxSize=nil) if maxSize.class == Fixnum && !block_given? @j_del.java_method(:setWriteQueueMaxSize, [Java::int.java_class]).call(maxSize) return self end raise ArgumentError, "Invalid arguments when calling set_write_queue_max_size(#{maxSize})" end |
- (true, false) ssl?
297 298 299 300 301 302 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 297 def ssl? if !block_given? return @j_del.java_method(:isSsl, []).call() end raise ArgumentError, "Invalid arguments when calling ssl?()" end |
- (String) sub_protocol
null when the handler receives the websocket callback as the
handshake will not be completed yet.
131 132 133 134 135 136 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 131 def sub_protocol if !block_given? return @j_del.java_method(:subProtocol, []).call() end raise ArgumentError, "Invalid arguments when calling sub_protocol()" end |
- (String) text_handler_id
WebSocket is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by textHandlerID.
Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.
120 121 122 123 124 125 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 120 def text_handler_id if !block_given? return @j_del.java_method(:textHandlerID, []).call() end raise ArgumentError, "Invalid arguments when calling text_handler_id()" end |
- (self) text_message_handler { ... }
224 225 226 227 228 229 230 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 224 def if true @j_del.java_method(:textMessageHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event) unless !block_given? })) return self end raise ArgumentError, "Invalid arguments when calling text_message_handler()" end |
- (String) uri
399 400 401 402 403 404 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 399 def uri if !block_given? return @j_del.java_method(:uri, []).call() end raise ArgumentError, "Invalid arguments when calling uri()" end |
- (void) write(data = nil) { ... }
This method returns an undefined value.
Same as but with anhandler called when the operation completes
49 50 51 52 53 54 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 49 def write(data=nil) if data.class.method_defined?(:j_del) && true return @j_del.java_method(:write, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(data.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) end raise ArgumentError, "Invalid arguments when calling write(#{data})" end |
- (self) write_binary_message(data = nil) { ... }
170 171 172 173 174 175 176 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 170 def (data=nil) if data.class.method_defined?(:j_del) && true @j_del.java_method(:writeBinaryMessage, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(data.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling write_binary_message(#{data})" end |
- (self) write_final_binary_frame(data = nil) { ... }
160 161 162 163 164 165 166 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 160 def write_final_binary_frame(data=nil) if data.class.method_defined?(:j_del) && true @j_del.java_method(:writeFinalBinaryFrame, [Java::IoVertxCoreBuffer::Buffer.java_class,Java::IoVertxCore::Handler.java_class]).call(data.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling write_final_binary_frame(#{data})" end |
- (self) write_final_text_frame(text = nil) { ... }
150 151 152 153 154 155 156 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 150 def write_final_text_frame(text=nil) if text.class == String && true @j_del.java_method(:writeFinalTextFrame, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(text,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling write_final_text_frame(#{text})" end |
- (self) write_frame(frame = nil) { ... }
140 141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 140 def write_frame(frame=nil) if frame.class.method_defined?(:j_del) && true @j_del.java_method(:writeFrame, [Java::IoVertxCoreHttp::WebSocketFrame.java_class,Java::IoVertxCore::Handler.java_class]).call(frame.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling write_frame(#{frame})" end |
- (self) write_ping(data = nil)
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.
There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.
196 197 198 199 200 201 202 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 196 def write_ping(data=nil) if data.class.method_defined?(:j_del) && !block_given? @j_del.java_method(:writePing, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del) return self end raise ArgumentError, "Invalid arguments when calling write_ping(#{data})" end |
- (self) write_pong(data = nil)
This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.
There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.
213 214 215 216 217 218 219 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 213 def write_pong(data=nil) if data.class.method_defined?(:j_del) && !block_given? @j_del.java_method(:writePong, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del) return self end raise ArgumentError, "Invalid arguments when calling write_pong(#{data})" end |
- (true, false) write_queue_full?
true if there are more bytes in the write queue than the value set using #set_write_queue_max_size
69 70 71 72 73 74 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 69 def write_queue_full? if !block_given? return @j_del.java_method(:writeQueueFull, []).call() end raise ArgumentError, "Invalid arguments when calling write_queue_full?()" end |
- (self) write_text_message(text = nil) { ... }
180 181 182 183 184 185 186 |
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/server_web_socket.rb', line 180 def (text=nil) if text.class == String && true @j_del.java_method(:writeTextMessage, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(text,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil) } unless !block_given?)) return self end raise ArgumentError, "Invalid arguments when calling write_text_message(#{text})" end |