Class: Vertx::WebSocket
- Inherits:
-
Object
show all
- Includes:
- WebSocketBase
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb
Overview
Represents a client-side WebSocket.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary
(collapse)
Instance Method Summary
(collapse)
Class Method Details
+ (Boolean) accept?(obj)
24
25
26
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 24
def @@j_api_type.accept?(obj)
obj.class == WebSocket
end
|
+ (Object) j_api_type
33
34
35
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 33
def self.j_api_type
@@j_api_type
end
|
+ (Object) j_class
36
37
38
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 36
def self.j_class
Java::IoVertxCoreHttp::WebSocket.java_class
end
|
+ (Object) unwrap(obj)
30
31
32
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 30
def @@j_api_type.unwrap(obj)
obj.j_del
end
|
+ (Object) wrap(obj)
27
28
29
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 27
def @@j_api_type.wrap(obj)
WebSocket.new(obj)
end
|
Instance Method Details
- (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.
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.
92
93
94
95
96
97
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 92
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 { ... }
Set a binary message handler on the connection. This handler serves a similar purpose to
#handler
except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated
into a single buffer before calling the handler (using Vertx::WebSocketFrame#is_final to find the boundaries).
171
172
173
174
175
176
177
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 171
def binary_message_handler
if block_given?
@j_del.java_method(:binaryMessageHandler, [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 binary_message_handler()"
end
|
- (void) close(statusCode = nil, reason = nil)
This method returns an undefined value.
Close sending a close frame with specified status code and reason. You can give a look at various close payloads
here: RFC6455
section 7.4.1
No more messages can be sent.
203
204
205
206
207
208
209
210
211
212
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 203
def close(statusCode=nil,reason=nil)
if !block_given? && statusCode == nil && reason == nil
return @j_del.java_method(:close, []).call()
elsif statusCode.class == Fixnum && !block_given? && reason == nil
return @j_del.java_method(:close, [Java::short.java_class]).call(::Vertx::Util::Utils.to_short(statusCode))
elsif statusCode.class == Fixnum && reason.class == String && !block_given?
return @j_del.java_method(:close, [Java::short.java_class,Java::java.lang.String.java_class]).call(::Vertx::Util::Utils.to_short(statusCode),reason)
end
raise ArgumentError, "Invalid arguments when calling close(#{statusCode},#{reason})"
end
|
- (self) close_handler { ... }
366
367
368
369
370
371
372
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 366
def close_handler
if block_given?
@j_del.java_method(:closeHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield })
return self
end
raise ArgumentError, "Invalid arguments when calling close_handler()"
end
|
- (self) drain_handler { ... }
312
313
314
315
316
317
318
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 312
def drain_handler
if block_given?
@j_del.java_method(:drainHandler, [Java::IoVertxCore::Handler.java_class]).call(Proc.new { yield })
return self
end
raise ArgumentError, "Invalid arguments when calling drain_handler()"
end
|
- (void) end(t = nil)
This method returns an undefined value.
Same as
Vertx::WebSocketBase#end but writes some data to the stream before ending.
42
43
44
45
46
47
48
49
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 42
def end(t=nil)
if !block_given? && t == nil
return @j_del.java_method(:end, []).call()
elsif t.class.method_defined?(:j_del) && !block_given?
return @j_del.java_method(:end, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(t.j_del)
end
raise ArgumentError, "Invalid arguments when calling end(#{t})"
end
|
- (self) end_handler { ... }
285
286
287
288
289
290
291
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 285
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 { ... }
242
243
244
245
246
247
248
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 242
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
|
- (self) fetch(amount = nil)
276
277
278
279
280
281
282
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 276
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 { ... }
375
376
377
378
379
380
381
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 375
def frame_handler
if block_given?
@j_del.java_method(:frameHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.safe_create(event,::Vertx::WebSocketFrame)) }))
return self
end
raise ArgumentError, "Invalid arguments when calling frame_handler()"
end
|
- (self) handler { ... }
251
252
253
254
255
256
257
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 251
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
|
Returns the local address for this socket
224
225
226
227
228
229
230
231
232
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 224
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
|
- (self) pause
259
260
261
262
263
264
265
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 259
def pause
if !block_given?
@j_del.java_method(:pause, []).call()
return self
end
raise ArgumentError, "Invalid arguments when calling pause()"
end
|
Pause this stream and return a to transfer the elements of this stream to a destination .
The stream will be resumed when the pipe will be wired to a
WriteStream
.
62
63
64
65
66
67
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 62
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 this
ReadStream
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.
77
78
79
80
81
82
83
84
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 77
def pipe_to(dst=nil)
if dst.class.method_defined?(:j_del) && !block_given?
return @j_del.java_method(:pipeTo, [Java::IoVertxCoreStreams::WriteStream.java_class]).call(dst.j_del)
elsif dst.class.method_defined?(:j_del) && block_given?
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) }))
end
raise ArgumentError, "Invalid arguments when calling pipe_to(#{dst})"
end
|
- (self) pong_handler { ... }
Set a pong frame handler on the connection. This handler will be invoked every time a pong frame is received
on the server, and can be used by both clients and servers since the RFC 6455
section 5.5.2 and
section 5.5.3 do not
specify whether the client or server sends a ping.
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.
189
190
191
192
193
194
195
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 189
def pong_handler
if block_given?
@j_del.java_method(:pongHandler, [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 pong_handler()"
end
|
Returns the remote address for this socket
214
215
216
217
218
219
220
221
222
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 214
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
267
268
269
270
271
272
273
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 267
def resume
if !block_given?
@j_del.java_method(:resume, []).call()
return self
end
raise ArgumentError, "Invalid arguments when calling resume()"
end
|
- (self) set_write_queue_max_size(maxSize = nil)
303
304
305
306
307
308
309
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 303
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?
234
235
236
237
238
239
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 234
def ssl?
if !block_given?
return @j_del.java_method(:isSsl, []).call()
end
raise ArgumentError, "Invalid arguments when calling ssl?()"
end
|
- (String) sub_protocol
Returns the WebSocket sub protocol selected by the WebSocket handshake.
On the server, the value will be
null
when the handler receives the websocket callback as the
handshake will not be completed yet.
116
117
118
119
120
121
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 116
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
When a
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.
105
106
107
108
109
110
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 105
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 { ... }
Set a text message handler on the connection. This handler will be called similar to the
, but the buffer will be converted to a String first
159
160
161
162
163
164
165
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 159
def text_message_handler
if block_given?
@j_del.java_method(:textMessageHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event) }))
return self
end
raise ArgumentError, "Invalid arguments when calling text_message_handler()"
end
|
- (self) write(data = nil)
294
295
296
297
298
299
300
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 294
def write(data=nil)
if data.class.method_defined?(:j_del) && !block_given?
@j_del.java_method(:write, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del)
return self
end
raise ArgumentError, "Invalid arguments when calling write(#{data})"
end
|
- (self) write_binary_message(data = nil)
348
349
350
351
352
353
354
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 348
def write_binary_message(data=nil)
if data.class.method_defined?(:j_del) && !block_given?
@j_del.java_method(:writeBinaryMessage, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del)
return self
end
raise ArgumentError, "Invalid arguments when calling write_binary_message(#{data})"
end
|
- (self) write_final_binary_frame(data = nil)
339
340
341
342
343
344
345
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 339
def write_final_binary_frame(data=nil)
if data.class.method_defined?(:j_del) && !block_given?
@j_del.java_method(:writeFinalBinaryFrame, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del)
return self
end
raise ArgumentError, "Invalid arguments when calling write_final_binary_frame(#{data})"
end
|
- (self) write_final_text_frame(text = nil)
330
331
332
333
334
335
336
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 330
def write_final_text_frame(text=nil)
if text.class == String && !block_given?
@j_del.java_method(:writeFinalTextFrame, [Java::java.lang.String.java_class]).call(text)
return self
end
raise ArgumentError, "Invalid arguments when calling write_final_text_frame(#{text})"
end
|
- (self) write_frame(frame = nil)
321
322
323
324
325
326
327
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 321
def write_frame(frame=nil)
if frame.class.method_defined?(:j_del) && !block_given?
@j_del.java_method(:writeFrame, [Java::IoVertxCoreHttp::WebSocketFrame.java_class]).call(frame.j_del)
return self
end
raise ArgumentError, "Invalid arguments when calling write_frame(#{frame})"
end
|
- (self) write_ping(data = nil)
Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).
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.
131
132
133
134
135
136
137
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 131
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)
Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).
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.
148
149
150
151
152
153
154
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 148
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?
52
53
54
55
56
57
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 52
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)
357
358
359
360
361
362
363
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx/web_socket.rb', line 357
def write_text_message(text=nil)
if text.class == String && !block_given?
@j_del.java_method(:writeTextMessage, [Java::java.lang.String.java_class]).call(text)
return self
end
raise ArgumentError, "Invalid arguments when calling write_text_message(#{text})"
end
|