Class: Vertx::WebSocket

Inherits:
Object
  • 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.

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.

Returns:

  • (String)
    the binary handler id

Raises:

  • (ArgumentError)


47
48
49
50
51
52
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 47

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)


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

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)


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

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)


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

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.

Parameters:

Raises:

  • (ArgumentError)


24
25
26
27
28
29
30
31
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 24

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)


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

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)


98
99
100
101
102
103
104
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 98

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)


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

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)


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

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::SocketAddress) local_address

@return the local address for this socket

Returns:

Raises:

  • (ArgumentError)


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

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

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

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

- (::Vertx::SocketAddress) remote_address

@return the remote address for this socket

Returns:

Raises:

  • (ArgumentError)


76
77
78
79
80
81
82
83
84
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 76

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)


123
124
125
126
127
128
129
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 123

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)


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

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)


60
61
62
63
64
65
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 60

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)

Parameters:

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

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)


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

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)


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

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)


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

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)


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

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)


34
35
36
37
38
39
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx/web_socket.rb', line 34

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