Class: VertxWeb::SockJSSocket

Inherits:
Object
  • Object
show all
Includes:
Vertx::ReadStream, Vertx::WriteStream
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb

Overview

You interact with SockJS clients through instances of SockJS socket.

The API is very similar to Vertx::WebSocket. It implements both Vertx::ReadStream and Vertx::WriteStream so it can be used with Vertx::Pump to pump data with flow control.

Instance Method Summary (collapse)

Instance Method Details

- (void) close

This method returns an undefined value.

Close it

Raises:

  • (ArgumentError)


123
124
125
126
127
128
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 123

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

- (self) drain_handler { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


101
102
103
104
105
106
107
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 101

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

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


74
75
76
77
78
79
80
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 74

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)


40
41
42
43
44
45
46
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 40

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

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


49
50
51
52
53
54
55
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 49

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

Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons

Returns:

  • (::Vertx::MultiMap)

Raises:

  • (ArgumentError)


148
149
150
151
152
153
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 148

def headers
  if !block_given?
    return ::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

Return the local address for this socket

Returns:

  • (::Vertx::SocketAddress)

Raises:

  • (ArgumentError)


139
140
141
142
143
144
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 139

def local_address
  if !block_given?
    return ::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)


57
58
59
60
61
62
63
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 57

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:

  • (::Vertx::SocketAddress)

Raises:

  • (ArgumentError)


131
132
133
134
135
136
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 131

def remote_address
  if !block_given?
    return ::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)


65
66
67
68
69
70
71
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 65

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)


92
93
94
95
96
97
98
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 92

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) uri

Return the URI corresponding to the last request for this socket or the websocket handshake

Returns:

  • (String)

Raises:

  • (ArgumentError)


156
157
158
159
160
161
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 156

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

- (::VertxWeb::Session) web_session

@return the Vert.x-Web session corresponding to this socket

Returns:

Raises:

  • (ArgumentError)


164
165
166
167
168
169
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 164

def web_session
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:webSession, []).call(),::VertxWeb::Session)
  end
  raise ArgumentError, "Invalid arguments when calling web_session()"
end

- (::VertxAuthCommon::User) web_user

@return the Vert.x-Web user corresponding to this socket

Returns:

  • (::VertxAuthCommon::User)

Raises:

  • (ArgumentError)


172
173
174
175
176
177
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 172

def web_user
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:webUser, []).call(),::VertxAuthCommon::User)
  end
  raise ArgumentError, "Invalid arguments when calling web_user()"
end

- (self) write(data = nil)

Parameters:

  • data (::Vertx::Buffer) (defaults to: nil)

Returns:

  • (self)

Raises:

  • (ArgumentError)


83
84
85
86
87
88
89
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 83

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

- (String) write_handler_id

When a SockJSSocket is created it automatically registers an event handler with the event bus, the ID of that handler is given by writeHandlerID.

Given this ID, a different event loop can send a buffer 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 socket. This allows you to write data to other sockets which are owned by different event loops.

Returns:

  • (String)

Raises:

  • (ArgumentError)


115
116
117
118
119
120
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 115

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

- (true, false) write_queue_full?

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


32
33
34
35
36
37
# File '/Users/julien/java/vertx-aggregator/modules/vertx-web/src/main/resources/vertx-web/sock_js_socket.rb', line 32

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