Class: VertxWeb::BridgeEvent

Inherits:
Vertx::Future show all
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb

Overview

Represents an event that occurs on the event bus bridge.

Please consult the documentation for a full explanation.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Vertx::Future

failed_future, future, succeeded_future

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


22
23
24
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 22

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

+ (Object) j_api_type



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

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



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

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

+ (Object) unwrap(obj)



28
29
30
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 28

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

+ (Object) wrap(obj)



25
26
27
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 25

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

Instance Method Details

- (Exception) cause

Returns:

  • (Exception)

Raises:

  • (ArgumentError)


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

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

- (void) complete(arg0 = nil)

This method returns an undefined value.

Parameters:

  • arg0 (true, false) (defaults to: nil)

Raises:

  • (ArgumentError)


55
56
57
58
59
60
61
62
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 55

def complete(arg0=nil)
  if !block_given? && arg0 == nil
    return @j_del.java_method(:complete, []).call()
  elsif (arg0.class == TrueClass || arg0.class == FalseClass) && !block_given?
    return @j_del.java_method(:complete, [Java::JavaLang::Boolean.java_class]).call(arg0)
  end
  raise ArgumentError, "Invalid arguments when calling complete(#{arg0})"
end

- (true, false) complete?

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


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

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

- (Proc) completer

Returns:

  • (Proc)

Raises:

  • (ArgumentError)


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

def completer
  if !block_given?
    if @cached_completer != nil
      return @cached_completer
    end
    return @cached_completer = ::Vertx::Util::Utils.to_async_result_handler_proc(@j_del.java_method(:completer, []).call()) { |val| val }
  end
  raise ArgumentError, "Invalid arguments when calling completer()"
end

- (::Vertx::Future) compose(mapper) { ... } - (::Vertx::Future) compose(handler)

Overloads:

Returns:

Raises:

  • (ArgumentError)


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

def compose(param_1=nil,param_2=nil)
  if block_given? && param_1 == nil && param_2 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(event).j_del })),::Vertx::Future, nil)
  elsif param_1.class == Proc && param_2.class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:compose, [Java::IoVertxCore::Handler.java_class,Java::IoVertxCore::Future.java_class]).call((Proc.new { |event| param_1.call(event) }),param_2.j_del),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling compose(#{param_1},#{param_2})"
end

- (void) fail(arg0) - (void) fail(arg0)

This method returns an undefined value.

Overloads:

  • - (void) fail(arg0)

    Parameters:

    • arg0 (Exception)
  • - (void) fail(arg0)

    Parameters:

    • arg0 (String)

Raises:

  • (ArgumentError)


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

def fail(param_1=nil)
  if param_1.is_a?(Exception) && !block_given?
    return @j_del.java_method(:fail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1))
  elsif param_1.class == String && !block_given?
    return @j_del.java_method(:fail, [Java::java.lang.String.java_class]).call(param_1)
  end
  raise ArgumentError, "Invalid arguments when calling fail(#{param_1})"
end

- (true, false) failed

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


121
122
123
124
125
126
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 121

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

- (Hash{String => Object}) get_raw_message

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved. If the returned message is modified, #set_raw_message should be called with the new message.

Returns:

  • (Hash{String => Object})
    the raw JSON message for the event

Raises:

  • (ArgumentError)


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

def get_raw_message
  if !block_given?
    return @j_del.java_method(:getRawMessage, []).call() != nil ? JSON.parse(@j_del.java_method(:getRawMessage, []).call().encode) : nil
  end
  raise ArgumentError, "Invalid arguments when calling get_raw_message()"
end

- (::Vertx::Future) map(mapper) { ... } - (::Vertx::Future) map(value)

Overloads:

Returns:

Raises:

  • (ArgumentError)


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

def map(param_1=nil)
  if block_given? && param_1 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| ::Vertx::Util::Utils.to_object(yield(event)) })),::Vertx::Future, nil)
  elsif ::Vertx::Util::unknown_type.accept?(param_1) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:map, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(param_1)),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling map(#{param_1})"
end

- (::Vertx::Future) map_empty

Returns:

Raises:

  • (ArgumentError)


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

def map_empty
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:mapEmpty, []).call(),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling map_empty()"
end

- (::Vertx::Future) otherwise(mapper) { ... } - (::Vertx::Future) otherwise(value)

Overloads:

Returns:

Raises:

  • (ArgumentError)


184
185
186
187
188
189
190
191
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 184

def otherwise(param_1=nil)
  if block_given? && param_1 == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)) })),::Vertx::Future, nil)
  elsif (param_1.class == TrueClass || param_1.class == FalseClass) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwise, [Java::JavaLang::Boolean.java_class]).call(param_1),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling otherwise(#{param_1})"
end

- (::Vertx::Future) otherwise_empty

Returns:

Raises:

  • (ArgumentError)


193
194
195
196
197
198
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 193

def otherwise_empty
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:otherwiseEmpty, []).call(),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling otherwise_empty()"
end

- (::Vertx::Future) recover(mapper = nil) { ... }

Yields:

Returns:

Raises:

  • (ArgumentError)


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

def recover(mapper=nil)
  if block_given? && mapper == nil
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:recover, [Java::JavaUtilFunction::Function.java_class]).call((Proc.new { |event| yield(::Vertx::Util::Utils.from_throwable(event)).j_del })),::Vertx::Future, nil)
  end
  raise ArgumentError, "Invalid arguments when calling recover(#{mapper})"
end

- (true, false) result

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


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

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

- (self) set_handler { ... }

Yields:

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def set_handler
  if block_given?
    @j_del.java_method(:setHandler, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) }))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling set_handler()"
end

- (self) set_raw_message(message = nil)

Get the raw JSON message for the event. This will be null for SOCKET_CREATED or SOCKET_CLOSED events as there is no message involved.

Parameters:

  • message (Hash{String => Object}) (defaults to: nil)
    the raw message

Returns:

  • (self)

Raises:

  • (ArgumentError)


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

def set_raw_message(message=nil)
  if message.class == Hash && !block_given?
    @j_del.java_method(:setRawMessage, [Java::IoVertxCoreJson::JsonObject.java_class]).call(::Vertx::Util::Utils.to_json_object(message))
    return self
  end
  raise ArgumentError, "Invalid arguments when calling set_raw_message(#{message})"
end

- (::VertxWeb::SockJSSocket) socket

Get the SockJSSocket instance corresponding to the event

Returns:

Raises:

  • (ArgumentError)


232
233
234
235
236
237
238
239
240
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 232

def socket
  if !block_given?
    if @cached_socket != nil
      return @cached_socket
    end
    return @cached_socket = ::Vertx::Util::Utils.safe_create(@j_del.java_method(:socket, []).call(),::VertxWeb::SockJSSocket)
  end
  raise ArgumentError, "Invalid arguments when calling socket()"
end

- (true, false) succeeded

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


114
115
116
117
118
119
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/bridge_event.rb', line 114

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

- (true, false) try_complete(arg0 = nil)

Parameters:

  • arg0 (true, false) (defaults to: nil)

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


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

def try_complete(arg0=nil)
  if !block_given? && arg0 == nil
    return @j_del.java_method(:tryComplete, []).call()
  elsif (arg0.class == TrueClass || arg0.class == FalseClass) && !block_given?
    return @j_del.java_method(:tryComplete, [Java::JavaLang::Boolean.java_class]).call(arg0)
  end
  raise ArgumentError, "Invalid arguments when calling try_complete(#{arg0})"
end

- (true, false) tryFail(arg0) - (true, false) tryFail(arg0)

Overloads:

  • - (true, false) tryFail(arg0)

    Parameters:

    • arg0 (Exception)
  • - (true, false) tryFail(arg0)

    Parameters:

    • arg0 (String)

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


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

def try_fail(param_1=nil)
  if param_1.is_a?(Exception) && !block_given?
    return @j_del.java_method(:tryFail, [Java::JavaLang::Throwable.java_class]).call(::Vertx::Util::Utils.to_throwable(param_1))
  elsif param_1.class == String && !block_given?
    return @j_del.java_method(:tryFail, [Java::java.lang.String.java_class]).call(param_1)
  end
  raise ArgumentError, "Invalid arguments when calling try_fail(#{param_1})"
end

- (:SOCKET_CREATED, ...) type

Returns the type of the event

Returns:

  • (:SOCKET_CREATED, :SOCKET_CLOSED, :SOCKET_IDLE, :SOCKET_PING, :SEND, :PUBLISH, :RECEIVE, :REGISTER, :UNREGISTER)
    the type of the event

Raises:

  • (ArgumentError)


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

def type
  if !block_given?
    if @cached_type != nil
      return @cached_type
    end
    return @cached_type = @j_del.java_method(:type, []).call().name.intern
  end
  raise ArgumentError, "Invalid arguments when calling type()"
end