Class: Vertx::EventBus
- Inherits:
-
Object
- Object
- Vertx::EventBus
- Defined in:
- src/main/ruby_scripts/core/event_bus.rb
Overview
For point to point messaging, messages can be sent to an address using the send method.
The messages will be delivered to a single handler, if one is registered on that address. If more than one
handler is registered on the same address, Vert.x will choose one and deliver the message to that. Vert.x will
aim to fairly distribute messages in a round-robin way, but does not guarantee strict round-robin under all
circumstances.
All messages sent over the bus are transient. On event of failure of all or part of the event bus messages
may be lost. Applications should be coded to cope with lost messages, e.g. by resending them,
and making application services idempotent.
The order of messages received by any specific handler from a specific sender should match the order of messages
sent from that sender.
When sending a message, a reply handler can be provided. If so, it will be called when the reply from the receiver
has been received. Reply messages can also be replied to, etc, ad infinitum.
Different event bus instances can be clustered together over a network, to give a single logical event bus.
When receiving a message in a handler the received object is an instance of EventBus::Message - this contains
the actual Hash of the message plus a reply method which can be used to reply to it.
Constant Summary
- @@handler_map =
{}
- @@j_eventbus =
org.vertx.java.deploy.impl.VertxLocator.vertx.eventBus()
Class Method Summary (collapse)
-
+ (Object) publish(address, message)
Publish a message on the event bus.
-
+ (FixNum) register_handler(address, local_only = false, &message_hndlr)
Register a handler.
-
+ (FixNum) register_simple_handler(local_only = false, &message_hndlr)
Registers a handler against a uniquely generated address, the address is returned as the id received by the handler.
-
+ (Object) send(address, message, &reply_handler)
Send a message on the event bus It will be called when the reply from a receiver is received.
-
+ (Object) unregister_handler(handler_id)
Unregisters a handler.
Class Method Details
+ (Object) publish(address, message)
Publish a message on the event bus
70 71 72 |
# File 'src/main/ruby_scripts/core/event_bus.rb', line 70 def EventBus.publish(address, ) EventBus.send_or_pub(false, address, ) end |
+ (FixNum) register_handler(address, local_only = false, &message_hndlr)
Register a handler.
received by the handler. A single handler can be registered against many addresses.
96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'src/main/ruby_scripts/core/event_bus.rb', line 96 def EventBus.register_handler(address, local_only = false, &) raise "An address must be specified" if !address raise "A message handler must be specified" if ! internal = InternalHandler.new() if local_only @@j_eventbus.registerLocalHandler(address, internal) else @@j_eventbus.registerHandler(address, internal) end id = java.util.UUID.randomUUID.toString @@handler_map[id] = [address, internal] id end |
+ (FixNum) register_simple_handler(local_only = false, &message_hndlr)
Registers a handler against a uniquely generated address, the address is returned as the id
received by the handler. A single handler can be registered against many addresses.
115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'src/main/ruby_scripts/core/event_bus.rb', line 115 def EventBus.register_simple_handler(local_only = false, &) raise "A message handler must be specified" if ! internal = InternalHandler.new() id = java.util.UUID.randomUUID.toString if local_only @@j_eventbus.registerLocalHandler(id, internal) else @@j_eventbus.registerHandler(id, internal) end @@handler_map[id] = [id, internal] id end |
+ (Object) send(address, message, &reply_handler)
Send a message on the event bus
It will be called when the reply from a receiver is received.
64 65 66 |
# File 'src/main/ruby_scripts/core/event_bus.rb', line 64 def EventBus.send(address, , &reply_handler) EventBus.send_or_pub(true, address, , reply_handler) end |
+ (Object) unregister_handler(handler_id)
Unregisters a handler
130 131 132 133 134 135 |
# File 'src/main/ruby_scripts/core/event_bus.rb', line 130 def EventBus.unregister_handler(handler_id) raise "A handler_id must be specified" if !handler_id tuple = @@handler_map.delete(handler_id) raise "Cannot find handler for id #{handler_id}" if !tuple @@j_eventbus.unregisterHandler(tuple.first, tuple.last) end |