io.vlingo.lattice.exchange.Exchange Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vlingo-lattice Show documentation

Tooling for reactive Domain-Driven Design projects that are highly concurrent. Includes compute grid, actor caching, spaces, cross-node cluster messaging, CQRS, and Event Sourcing support.

There is a newer version: 1.7.5

Show newest version

// Copyright © 2012-2020 VLINGO LABS. All rights reserved.
//
// This Source Code Form is subject to the terms of the
// Mozilla Public License, v. 2.0. If a copy of the MPL
// was not distributed with this file, You can obtain
// one at https://mozilla.org/MPL/2.0/.

package io.vlingo.lattice.exchange;

/**
 * Defines a message exchange, such as a queue or topic, through which any number of related
 * {@code ExchangeSender}, {@code ExchangeReceiver}, and {@code ExchangeAdapter} components
 * are registered, and messages are sent.
 */
public interface Exchange {

  /**
   * Close this Exchange and any underlying resources.
   */
  void close();

  /**
   * Answer my channel, which is implementation dependent.
   * @param  the type of the channel
   * @return T
   */
   T channel();

  /**
   * Answer my connect, which is implementation dependent.
   * @param  the type of the connection
   * @return T
   */
   T connection();

  /**
   * Answer my name.
   * @return String
   */
  String name();

  /**
   * Registers a {@code Covey} with this Exchange.
   * @param covey the {@code Covey} to register
   * @param  the local object type
   * @param  the external object type
   * @param  the exchange message type
   * @return Exchange
   */
   Exchange register(final Covey covey);

  /**
   * Sends the {@code local} message to the exchange after first adapting it to a exchange message.
   * @param local the L local message to send as an exchange message
   * @param  the local type
   */
   void send(final L local);
}