Class: VertxWeb::SockJSSocket

Inherits:
Object
  • Object
show all
Includes:
Vertx::ReadStream, Vertx::WriteStream
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/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 and so it can be used with Vertx::Pump to pump data with flow control.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


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

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

+ (Object) j_api_type



41
42
43
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 41

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



44
45
46
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 44

def self.j_class
  Java::IoVertxExtWebHandlerSockjs::SockJSSocket.java_class
end

+ (Object) unwrap(obj)



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

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

+ (Object) wrap(obj)



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

def @@j_api_type.wrap(obj)
  SockJSSocket.new(obj)
end

Instance Method Details

- (void) close

This method returns an undefined value.

Close it

Raises:

  • (ArgumentError)


156
157
158
159
160
161
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 156

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)


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

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.

Parameters:

Raises:

  • (ArgumentError)


49
50
51
52
53
54
55
56
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 49

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)


100
101
102
103
104
105
106
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 100

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)


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

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

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


75
76
77
78
79
80
81
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 75

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:

Raises:

  • (ArgumentError)


181
182
183
184
185
186
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 181

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:

Raises:

  • (ArgumentError)


172
173
174
175
176
177
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 172

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)


83
84
85
86
87
88
89
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 83

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)


164
165
166
167
168
169
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 164

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)


91
92
93
94
95
96
97
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 91

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)


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

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)


189
190
191
192
193
194
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 189

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

Returns the Vert.x-Web session corresponding to this socket

Returns:

Raises:

  • (ArgumentError)


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

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

Returns the Vert.x-Web user corresponding to this socket

Returns:

Raises:

  • (ArgumentError)


203
204
205
206
207
208
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 203

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) - (self) write(data)

Write a String to the socket, encoded in UTF-8.

Overloads:

  • - (self) write(data)

    Parameters:

  • - (self) write(data)

    Parameters:

    • data (String)
      the string to write

Returns:

  • (self)

Raises:

  • (ArgumentError)


113
114
115
116
117
118
119
120
121
122
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 113

def write(param_1=nil)
  if param_1.class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:write, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(param_1.j_del)
    return self
  elsif param_1.class == String && !block_given?
    @j_del.java_method(:write, [Java::java.lang.String.java_class]).call(param_1)
    return self
  end
  raise ArgumentError, "Invalid arguments when calling write(#{param_1})"
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)


148
149
150
151
152
153
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 148

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)


58
59
60
61
62
63
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 58

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