Class: Vertx::WebSocket
- Inherits:
-
Object
show all
- Includes:
- WebSocketBase
- Defined in:
- /Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb
Overview
Represents a client-side WebSocket.
Instance Method Summary
(collapse)
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.
36
37
38
39
40
41
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 36
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.
57
58
59
60
61
62
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 57
def close
if !block_given?
return @j_del.java_method(:close, []).call()
end
raise ArgumentError, "Invalid arguments when calling close()"
end
|
- (self) close_handler { ... }
175
176
177
178
179
180
181
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 175
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 { ... }
148
149
150
151
152
153
154
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 148
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
|
- (self) end_handler { ... }
121
122
123
124
125
126
127
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 121
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 { ... }
87
88
89
90
91
92
93
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 87
def exception_handler
if block_given?
@j_del.java_method(:exceptionHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(event) }))
return self
end
raise ArgumentError, "Invalid arguments when calling exception_handler()"
end
|
- (self) frame_handler { ... }
184
185
186
187
188
189
190
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 184
def frame_handler
if block_given?
@j_del.java_method(:frameHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::WebSocketFrame.new(event)) }))
return self
end
raise ArgumentError, "Invalid arguments when calling frame_handler()"
end
|
- (self) handler { ... }
96
97
98
99
100
101
102
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 96
def handler
if block_given?
@j_del.java_method(:handler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |event| yield(::Vertx::Buffer.new(event)) }))
return self
end
raise ArgumentError, "Invalid arguments when calling handler()"
end
|
@return the local address for this socket
76
77
78
79
80
81
82
83
84
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 76
def local_address
if !block_given?
if @cached_local_address != nil
return @cached_local_address
end
return @cached_local_address = ::Vertx::SocketAddress.new(@j_del.java_method(:localAddress, []).call())
end
raise ArgumentError, "Invalid arguments when calling local_address()"
end
|
- (self) pause
104
105
106
107
108
109
110
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 104
def pause
if !block_given?
@j_del.java_method(:pause, []).call()
return self
end
raise ArgumentError, "Invalid arguments when calling pause()"
end
|
@return the remote address for this socket
65
66
67
68
69
70
71
72
73
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 65
def remote_address
if !block_given?
if @cached_remote_address != nil
return @cached_remote_address
end
return @cached_remote_address = ::Vertx::SocketAddress.new(@j_del.java_method(:remoteAddress, []).call())
end
raise ArgumentError, "Invalid arguments when calling remote_address()"
end
|
- (self) resume
112
113
114
115
116
117
118
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 112
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)
139
140
141
142
143
144
145
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 139
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.
49
50
51
52
53
54
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 49
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)
130
131
132
133
134
135
136
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 130
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_frame(frame = nil)
157
158
159
160
161
162
163
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 157
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_message(data = nil)
166
167
168
169
170
171
172
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 166
def write_message(data=nil)
if data.class.method_defined?(:j_del) && !block_given?
@j_del.java_method(:writeMessage, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(data.j_del)
return self
end
raise ArgumentError, "Invalid arguments when calling write_message(data)"
end
|
- (true, false) write_queue_full?
23
24
25
26
27
28
|
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/src/main/resources/vertx/web_socket.rb', line 23
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
|