io.vertx.reactivex.ext.stomp.Destination Maven / Gradle / Ivy

Go to download
/*
 * 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.reactivex.ext.stomp;

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import io.vertx.ext.stomp.BridgeOptions;
import java.util.List;
import io.vertx.ext.stomp.Frame;
import io.vertx.reactivex.core.Vertx;
import io.vertx.core.shareddata.Shareable;

/**
 * Represents a STOMP destination.
 * Depending on the implementation, the message delivery is different. Queue are sending message to only one
 * subscribers, while topics are broadcasting the message to all subscribers.
 * 
 * Implementations must be thread-safe.
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.stomp.Destination original} non RX-ified interface using Vert.x codegen.
 */

@io.vertx.lang.reactivex.RxGen(io.vertx.ext.stomp.Destination.class)
public class Destination {

  @Override
  public String toString() {
    return delegate.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    Destination that = (Destination) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final io.vertx.lang.reactivex.TypeArg __TYPE_ARG = new io.vertx.lang.reactivex.TypeArg<>(
    obj -> new Destination((io.vertx.ext.stomp.Destination) obj),
    Destination::getDelegate
  );

  private final io.vertx.ext.stomp.Destination delegate;
  
  public Destination(io.vertx.ext.stomp.Destination delegate) {
    this.delegate = delegate;
  }

  public io.vertx.ext.stomp.Destination getDelegate() {
    return delegate;
  }

  public static Destination topic(Vertx vertx, String destination) { 
    Destination ret = Destination.newInstance(io.vertx.ext.stomp.Destination.topic(vertx.getDelegate(), destination));
    return ret;
  }

  public static Destination queue(Vertx vertx, String destination) { 
    Destination ret = Destination.newInstance(io.vertx.ext.stomp.Destination.queue(vertx.getDelegate(), destination));
    return ret;
  }

  public static Destination bridge(Vertx vertx, BridgeOptions options) { 
    Destination ret = Destination.newInstance(io.vertx.ext.stomp.Destination.bridge(vertx.getDelegate(), options));
    return ret;
  }

  /**
   * @return the destination address.
   */
  public String destination() { 
    String ret = delegate.destination();
    return ret;
  }

  /**
   * Dispatches the given frame.
   * @param connection the connection
   * @param frame the frame
   * @return the current instance of {@link io.vertx.reactivex.ext.stomp.Destination}
   */
  public Destination dispatch(StompServerConnection connection, Frame frame) { 
    delegate.dispatch(connection.getDelegate(), frame);
    return this;
  }

  /**
   * Handles a subscription request to the current {@link io.vertx.reactivex.ext.stomp.Destination}.
   * @param connection the connection
   * @param frame the SUBSCRIBE frame
   * @return the current instance of {@link io.vertx.reactivex.ext.stomp.Destination}
   */
  public Destination subscribe(StompServerConnection connection, Frame frame) { 
    delegate.subscribe(connection.getDelegate(), frame);
    return this;
  }

  /**
   * Handles a un-subscription request to the current {@link io.vertx.reactivex.ext.stomp.Destination}.
   * @param connection the connection
   * @param frame the UNSUBSCRIBE frame
   * @return true if the un-subscription has been handled, false otherwise.
   */
  public boolean unsubscribe(StompServerConnection connection, Frame frame) { 
    boolean ret = delegate.unsubscribe(connection.getDelegate(), frame);
    return ret;
  }

  /**
   * Removes all subscriptions of the given connection
   * @param connection the connection
   * @return the current instance of {@link io.vertx.reactivex.ext.stomp.Destination}
   */
  public Destination unsubscribeConnection(StompServerConnection connection) { 
    delegate.unsubscribeConnection(connection.getDelegate());
    return this;
  }

  /**
   * Handles a ACK frame.
   * @param connection the connection
   * @param frame the ACK frame
   * @return true if the destination has handled the frame (meaning it has sent the message with id)
   */
  public boolean ack(StompServerConnection connection, Frame frame) { 
    boolean ret = delegate.ack(connection.getDelegate(), frame);
    return ret;
  }

  /**
   * Handles a NACK frame.
   * @param connection the connection
   * @param frame the NACK frame
   * @return true if the destination has handled the frame (meaning it has sent the message with id)
   */
  public boolean nack(StompServerConnection connection, Frame frame) { 
    boolean ret = delegate.nack(connection.getDelegate(), frame);
    return ret;
  }

  /**
   * Gets all subscription ids for the given destination hold by the given client
   * @param connection the connection (client)
   * @return the list of subscription id, empty if none
   */
  public List getSubscriptions(StompServerConnection connection) { 
    List ret = delegate.getSubscriptions(connection.getDelegate());
    return ret;
  }

  /**
   * Gets the number of subscriptions attached to the current {@link io.vertx.reactivex.ext.stomp.Destination}.
   * @return the number of subscriptions.
   */
  public int numberOfSubscriptions() { 
    int ret = delegate.numberOfSubscriptions();
    return ret;
  }

  /**
   * Checks whether or not the given address matches with the current destination.
   * @param address the address
   * @return true if it matches, false otherwise.
   */
  public boolean matches(String address) { 
    boolean ret = delegate.matches(address);
    return ret;
  }


  public static  Destination newInstance(io.vertx.ext.stomp.Destination arg) {
    return arg != null ? new Destination(arg) : null;
  }
}