Class: Vertx::ServerWebSocket

Inherits:
Object
  • Object
show all
Includes:
WebSocketBase
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb

Overview

Represents a server side WebSocket.

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)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


26
27
28
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 26

def @@j_api_type.accept?(obj)
  obj.class == ServerWebSocket
end

+ (Object) j_api_type



35
36
37
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 35

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



38
39
40
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 38

def self.j_class
  Java::IoVertxCoreHttp::ServerWebSocket.java_class
end

+ (Object) unwrap(obj)



32
33
34
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 32

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



29
30
31
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 29

def @@j_api_type.wrap(obj)
  ServerWebSocket.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.

Returns:

  • (String)
    the binary handler id

Raises:

  • (ArgumentError)


67
68
69
70
71
72
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 67

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.

Raises:

  • (ArgumentError)


88
89
90
91
92
93
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 88

def close
  if !block_given?
    return @j_del.java_method(:close, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling close()"
end

- (self) close_handler { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


222
223
224
225
226
227
228
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 222

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 { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


177
178
179
180
181
182
183
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 177

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 WebSocketBase#end but writes some data to the stream before ending.

Parameters:

Raises:

  • (ArgumentError)


44
45
46
47
48
49
50
51
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 44

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 { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


150
151
152
153
154
155
156
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 150

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 { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


116
117
118
119
120
121
122
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 116

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 { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


231
232
233
234
235
236
237
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 231

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 { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


125
126
127
128
129
130
131
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 125

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

- (::Vertx::MultiMap) headers

Returns the headers in the WebSocket handshake

Returns:

Raises:

  • (ArgumentError)


260
261
262
263
264
265
266
267
268
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 260

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

Returns the local address for this socket

Returns:

Raises:

  • (ArgumentError)


105
106
107
108
109
110
111
112
113
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 105

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

Returns the WebSocket handshake path.

Returns:

  • (String)
    the WebSocket handshake path.

Raises:

  • (ArgumentError)


246
247
248
249
250
251
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 246

def path
  if !block_given?
    return @j_del.java_method(:path, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling path()"
end

- (self) pause

Returns:

  • (self)

Raises:

  • (ArgumentError)


133
134
135
136
137
138
139
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 133

def pause
  if !block_given?
    @j_del.java_method(:pause, []).call()
    return self
  end
  raise ArgumentError, "Invalid arguments when calling pause()"
end

- (String) query

Returns the WebSocket handshake query string.

Returns:

  • (String)
    the WebSocket handshake query string.

Raises:

  • (ArgumentError)


253
254
255
256
257
258
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 253

def query
  if !block_given?
    return @j_del.java_method(:query, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling query()"
end

- (void) reject

This method returns an undefined value.

Reject the WebSocket.

Calling this method from the websocket handler when it is first passed to you gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.

You might use this method, if for example you only want to accept WebSockets with a particular path.

Raises:

  • (ArgumentError)


277
278
279
280
281
282
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 277

def reject
  if !block_given?
    return @j_del.java_method(:reject, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling reject()"
end

- (::Vertx::SocketAddress) remote_address

Returns the remote address for this socket

Returns:

Raises:

  • (ArgumentError)


95
96
97
98
99
100
101
102
103
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 95

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

Returns:

  • (self)

Raises:

  • (ArgumentError)


141
142
143
144
145
146
147
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 141

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)

Parameters:

  • maxSize (Fixnum) (defaults to: nil)

Returns:

  • (self)

Raises:

  • (ArgumentError)


168
169
170
171
172
173
174
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 168

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.

Returns:

  • (String)

Raises:

  • (ArgumentError)


80
81
82
83
84
85
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 80

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

- (String) uri

Returns:

  • (String)

Raises:

  • (ArgumentError)


239
240
241
242
243
244
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 239

def uri
  if !block_given?
    return @j_del.java_method(:uri, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling uri()"
end

- (self) write(data = nil)

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


159
160
161
162
163
164
165
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 159

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)

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


213
214
215
216
217
218
219
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 213

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)

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


204
205
206
207
208
209
210
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 204

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)

Parameters:

  • text (String) (defaults to: nil)

Returns:

  • (self)

Raises:

  • (ArgumentError)


195
196
197
198
199
200
201
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 195

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)

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


186
187
188
189
190
191
192
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 186

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?

This will return true if there are more bytes in the write queue than the value set using #set_write_queue_max_size

Returns:

  • (true, false)
    true if write queue is full

Raises:

  • (ArgumentError)


54
55
56
57
58
59
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/server_web_socket.rb', line 54

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