All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.vertx.groovy.core.eventbus.EventBus.groovy Maven / Gradle / Ivy

    There is a newer version: 5.0.0.CR3
    Show newest version
    /*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.groovy.core.eventbus;
import groovy.transform.CompileStatic
import io.vertx.lang.groovy.InternalHelper
import io.vertx.core.json.JsonObject
import io.vertx.core.eventbus.DeliveryOptions
import io.vertx.groovy.core.metrics.Measured
import io.vertx.core.AsyncResult
import io.vertx.core.Handler
/**
 * A Vert.x event-bus is a light-weight distributed messaging system which allows different parts of your application,
 * or different applications and services to communicate with each in a loosely coupled way.
 * 
    
 * An event-bus supports publish-subscribe messaging, point-to-point messaging and request-response messaging.
 * 
    
 * Message delivery is best-effort and messages can be lost if failure of all or part of the event bus occurs.
 * 
    
 * Please refer to the documentation for more information on the event bus.
*/
@CompileStatic
public class EventBus implements Measured {
  private final def io.vertx.core.eventbus.EventBus delegate;
  public EventBus(Object delegate) {
    this.delegate = (io.vertx.core.eventbus.EventBus) delegate;
  }
  public Object getDelegate() {
    return delegate;
  }
  /**
   * Whether the metrics are enabled for this measured object
   * @return true if the metrics are enabled
   */
  public boolean isMetricsEnabled() {
    def ret = ((io.vertx.core.metrics.Measured) this.delegate).isMetricsEnabled();
    return ret;
  }
  /**
   * Sends a message.
   * 
    
   * The message will be delivered to at most one of the handlers registered to the address.
   * @param address the address to send it to
   * @param message the message, may be null
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus send(String address, Object message) {
    this.delegate.send(address, InternalHelper.unwrapObject(message));
    return this;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#send} but specifying a replyHandler that will be called if the recipient
   * subsequently replies to the message.
   * @param address the address to send it to
   * @param message the message, may be null
   * @param replyHandler reply handler will be called when any reply from the recipient is received, may be null
   * @return a reference to this, so the API can be used fluently
   */
  public  EventBus send(String address, Object message, Handler>> replyHandler) {
    this.delegate.send(address, InternalHelper.unwrapObject(message), new Handler>>() {
      public void handle(AsyncResult> event) {
        AsyncResult> f
        if (event.succeeded()) {
          f = InternalHelper.>result(new Message(event.result()))
        } else {
          f = InternalHelper.>failure(event.cause())
        }
        replyHandler.handle(f)
      }
    });
    return this;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#send} but specifying options that can be used to configure the delivery.
   * @param address the address to send it to
   * @param message the message, may be null
   * @param options delivery options (see DeliveryOptions)
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus send(String address, Object message, Map options) {
    this.delegate.send(address, InternalHelper.unwrapObject(message), options != null ? new io.vertx.core.eventbus.DeliveryOptions(new io.vertx.core.json.JsonObject(options)) : null);
    return this;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#send} but specifying a replyHandler that will be called if the recipient
   * subsequently replies to the message.
   * @param address the address to send it to
   * @param message the message, may be null
   * @param options delivery options (see DeliveryOptions)
   * @param replyHandler reply handler will be called when any reply from the recipient is received, may be null
   * @return a reference to this, so the API can be used fluently
   */
  public  EventBus send(String address, Object message, Map options, Handler>> replyHandler) {
    this.delegate.send(address, InternalHelper.unwrapObject(message), options != null ? new io.vertx.core.eventbus.DeliveryOptions(new io.vertx.core.json.JsonObject(options)) : null, new Handler>>() {
      public void handle(AsyncResult> event) {
        AsyncResult> f
        if (event.succeeded()) {
          f = InternalHelper.>result(new Message(event.result()))
        } else {
          f = InternalHelper.>failure(event.cause())
        }
        replyHandler.handle(f)
      }
    });
    return this;
  }
  /**
   * Publish a message.
    
   * The message will be delivered to all handlers registered to the address.
   * @param address the address to publish it to
   * @param message the message, may be null
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus publish(String address, Object message) {
    this.delegate.publish(address, InternalHelper.unwrapObject(message));
    return this;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#publish} but specifying options that can be used to configure the delivery.
   * @param address the address to publish it to
   * @param message the message, may be null
   * @param options the delivery options (see DeliveryOptions)
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus publish(String address, Object message, Map options) {
    this.delegate.publish(address, InternalHelper.unwrapObject(message), options != null ? new io.vertx.core.eventbus.DeliveryOptions(new io.vertx.core.json.JsonObject(options)) : null);
    return this;
  }
  /**
   * Create a message consumer against the specified address.
   * 
    
   * The returned consumer is not yet registered
   * at the address, registration will be effective when {@link io.vertx.groovy.core.eventbus.MessageConsumer#handler}
   * is called.
   * @param address the address that it will register it at
   * @return the event bus message consumer
   */
  public  MessageConsumer consumer(String address) {
    def ret= InternalHelper.safeCreate(this.delegate.consumer(address), io.vertx.groovy.core.eventbus.MessageConsumer.class);
    return ret;
  }
  /**
   * Create a consumer and register it against the specified address.
   * @param address the address that will register it at
   * @param handler the handler that will process the received messages
   * @return the event bus message consumer
   */
  public  MessageConsumer consumer(String address, Handler> handler) {
    def ret= InternalHelper.safeCreate(this.delegate.consumer(address, new Handler>() {
      public void handle(io.vertx.core.eventbus.Message event) {
        handler.handle(new io.vertx.groovy.core.eventbus.Message(event));
      }
    }), io.vertx.groovy.core.eventbus.MessageConsumer.class);
    return ret;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#consumer} but the address won't be propagated across the cluster.
   * @param address the address to register it at
   * @return the event bus message consumer
   */
  public  MessageConsumer localConsumer(String address) {
    def ret= InternalHelper.safeCreate(this.delegate.localConsumer(address), io.vertx.groovy.core.eventbus.MessageConsumer.class);
    return ret;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#consumer} but the address won't be propagated across the cluster.
   * @param address the address that will register it at
   * @param handler the handler that will process the received messages
   * @return the event bus message consumer
   */
  public  MessageConsumer localConsumer(String address, Handler> handler) {
    def ret= InternalHelper.safeCreate(this.delegate.localConsumer(address, new Handler>() {
      public void handle(io.vertx.core.eventbus.Message event) {
        handler.handle(new io.vertx.groovy.core.eventbus.Message(event));
      }
    }), io.vertx.groovy.core.eventbus.MessageConsumer.class);
    return ret;
  }
  /**
   * Create a message sender against the specified address.
   * 
    
   * The returned sender will invoke the {@link io.vertx.groovy.core.eventbus.EventBus#send}
   * method when the stream {@link io.vertx.groovy.core.streams.WriteStream#write} method is called with the sender
   * address and the provided data.
   * @param address the address to send it to
   * @return The sender
   */
  public  MessageProducer sender(String address) {
    def ret= InternalHelper.safeCreate(this.delegate.sender(address), io.vertx.groovy.core.eventbus.MessageProducer.class);
    return ret;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#sender} but specifying delivery options that will be used for configuring the delivery of
   * the message.
   * @param address the address to send it to
   * @param options the delivery options (see DeliveryOptions)
   * @return The sender
   */
  public  MessageProducer sender(String address, Map options) {
    def ret= InternalHelper.safeCreate(this.delegate.sender(address, options != null ? new io.vertx.core.eventbus.DeliveryOptions(new io.vertx.core.json.JsonObject(options)) : null), io.vertx.groovy.core.eventbus.MessageProducer.class);
    return ret;
  }
  /**
   * Create a message publisher against the specified address.
   * 
    
   * The returned publisher will invoke the {@link io.vertx.groovy.core.eventbus.EventBus#publish}
   * method when the stream {@link io.vertx.groovy.core.streams.WriteStream#write} method is called with the publisher
   * address and the provided data.
   * @param address The address to publish it to
   * @return The publisher
   */
  public  MessageProducer publisher(String address) {
    def ret= InternalHelper.safeCreate(this.delegate.publisher(address), io.vertx.groovy.core.eventbus.MessageProducer.class);
    return ret;
  }
  /**
   * Like {@link io.vertx.groovy.core.eventbus.EventBus#publisher} but specifying delivery options that will be used for configuring the delivery of
   * the message.
   * @param address the address to publish it to
   * @param options the delivery options (see DeliveryOptions)
   * @return The publisher
   */
  public  MessageProducer publisher(String address, Map options) {
    def ret= InternalHelper.safeCreate(this.delegate.publisher(address, options != null ? new io.vertx.core.eventbus.DeliveryOptions(new io.vertx.core.json.JsonObject(options)) : null), io.vertx.groovy.core.eventbus.MessageProducer.class);
    return ret;
  }
  /**
   * Add an interceptor that will be called whenever a message is sent from Vert.x
   * @param interceptor the interceptor
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus addInterceptor(Handler interceptor) {
    def ret= InternalHelper.safeCreate(this.delegate.addInterceptor(new Handler() {
      public void handle(io.vertx.core.eventbus.SendContext event) {
        interceptor.handle(new io.vertx.groovy.core.eventbus.SendContext(event));
      }
    }), io.vertx.groovy.core.eventbus.EventBus.class);
    return ret;
  }
  /**
   * Remove an interceptor
   * @param interceptor the interceptor
   * @return a reference to this, so the API can be used fluently
   */
  public EventBus removeInterceptor(Handler interceptor) {
    def ret= InternalHelper.safeCreate(this.delegate.removeInterceptor(new Handler() {
      public void handle(io.vertx.core.eventbus.SendContext event) {
        interceptor.handle(new io.vertx.groovy.core.eventbus.SendContext(event));
      }
    }), io.vertx.groovy.core.eventbus.EventBus.class);
    return ret;
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy