Class: Vertx::WebSocket
- Inherits:
-
Object
show all
- Includes:
- WebSocketBase
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/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)
22
23
24
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 22
def @@j_api_type.accept?(obj)
obj.class == WebSocket
end
|
+ (Object) j_api_type
31
32
33
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 31
def self.j_api_type
@@j_api_type
end
|
+ (Object) j_class
34
35
36
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 34
def self.j_class
Java::IoVertxCoreHttp::WebSocket.java_class
end
|
+ (Object) unwrap(obj)
28
29
30
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 28
def @@j_api_type.unwrap(obj)
obj.j_del
end
|
+ (Object) wrap(obj)
25
26
27
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 25
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.
63
64
65
66
67
68
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 63
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
|
- (void) close
This method returns an undefined value.
Close the WebSocket.
84
85
86
87
88
89
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 84
def close
if !block_given?
return @j_del.java_method(:close, []).call()
end
raise ArgumentError, "Invalid arguments when calling close()"
end
|
- (self) close_handler { ... }
218
219
220
221
222
223
224
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 218
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 { ... }
173
174
175
176
177
178
179
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 173
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.
40
41
42
43
44
45
46
47
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 40
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 { ... }
146
147
148
149
150
151
152
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 146
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 { ... }
112
113
114
115
116
117
118
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 112
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) frame_handler { ... }
227
228
229
230
231
232
233
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 227
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 { ... }
121
122
123
124
125
126
127
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 121
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
101
102
103
104
105
106
107
108
109
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 101
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
129
130
131
132
133
134
135
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 129
def pause
if !block_given?
@j_del.java_method(:pause, []).call()
return self
end
raise ArgumentError, "Invalid arguments when calling pause()"
end
|
Returns the remote address for this socket
91
92
93
94
95
96
97
98
99
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 91
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
137
138
139
140
141
142
143
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 137
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)
164
165
166
167
168
169
170
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 164
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
|
- (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.
76
77
78
79
80
81
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 76
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) write(data = nil)
155
156
157
158
159
160
161
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 155
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)
209
210
211
212
213
214
215
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 209
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)
200
201
202
203
204
205
206
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 200
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)
191
192
193
194
195
196
197
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 191
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)
182
183
184
185
186
187
188
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 182
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
|
- (true, false) write_queue_full?
50
51
52
53
54
55
|
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 50
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
|