Class: VertxWeb::SockJSSocket
- Inherits:
-
Object
- Object
- VertxWeb::SockJSSocket
- 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.
Instance Method Summary (collapse)
-
- (void) close
Close it.
- - (self) drain_handler { ... }
- - (void) end(t = nil)
- - (self) end_handler { ... }
- - (self) exception_handler { ... }
- - (self) handler { ... }
-
- (::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.
-
- (::Vertx::SocketAddress) local_address
Return the local address for this socket.
- - (self) pause
-
- (::Vertx::SocketAddress) remote_address
Return the remote address for this socket.
- - (self) resume
- - (self) set_write_queue_max_size(maxSize = nil)
-
- (String) uri
Return the URI corresponding to the last request for this socket or the websocket handshake.
-
- (::VertxWeb::Session) web_session
@return the Vert.x-Web session corresponding to this socket.
-
- (::VertxAuthCommon::User) web_user
@return the Vert.x-Web user corresponding to this socket.
- - (self) write(data = nil)
-
- (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.
- - (true, false) write_queue_full?
Instance Method Details
- (void) close
This method returns an undefined value.
Close it
133 134 135 136 137 138 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 133 def close if !block_given? return @j_del.java_method(:close, []).call() end raise ArgumentError, "Invalid arguments when calling close()" end |
- (self) drain_handler { ... }
111 112 113 114 115 116 117 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 111 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.
33 34 35 36 37 38 39 40 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 33 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 { ... }
84 85 86 87 88 89 90 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 84 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 { ... }
50 51 52 53 54 55 56 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 50 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 { ... }
59 60 61 62 63 64 65 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 59 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
158 159 160 161 162 163 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 158 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
149 150 151 152 153 154 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 149 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
67 68 69 70 71 72 73 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 67 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
141 142 143 144 145 146 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 141 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
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 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)
102 103 104 105 106 107 108 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 102 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
166 167 168 169 170 171 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 166 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
174 175 176 177 178 179 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 174 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
182 183 184 185 186 187 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 182 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)
93 94 95 96 97 98 99 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 93 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.
125 126 127 128 129 130 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 125 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?
42 43 44 45 46 47 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/sock_js_socket.rb', line 42 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 |