io.vlingo.actors.DirectoryScanner Maven / Gradle / Ivy

Go to download

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

Type safe Actor Model toolkit for reactive concurrency and resiliency using Java and other JVM languages.

There is a newer version: 1.7.5

// 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.actors;

import java.util.Optional;

import io.vlingo.common.Completes;

/**
 * Protocol to find an actor of a given address and protocol.
 */
public interface DirectoryScanner {
  /**
   * Answer the {@code protocol} reference of the actor with {@code address} as a
   * {@code Completes} eventual outcome, or {@code null} as a {@code Completes}
   * eventual outcome if not found.
   * @param protocol the {@code Class} of the protocol that the actor must support
   * @param address the {@code Address} of the actor to find
   * @param  the protocol type
   * @return {@code Completes}
   */
   Completes actorOf(final Class protocol, final Address address);

  /**
   * Answers the {@code Completes} that will eventually complete with the {@code T} protocol
   * of the backing {@code Actor} of the given {@code address}, or a new {@code Actor} instance
   * of the {@code type} and {@code definition}.
   * @param  the protocol type
   * @param protocol the {@code Class} protocol supported by the backing {@code Actor}
   * @param address the {@code Address} of the {@code Actor} to find and to create the new Actor with if not found
   * @param definition the {@code Definition} providing parameters to the {@code Actor}
   * @return {@code Completes}
   */
   Completes actorOf(final Class protocol, final Address address, final Definition definition);

  /**
   * Answer the {@code protocol} reference of the actor with {@code address} as a non-empty
   * {@code Completes>} eventual outcome, or an empty {@code Optional} if not found.
   * @param protocol the {@code Class} of the protocol that the actor must support
   * @param address the {@code Address} of the actor to find
   * @param  the protocol type
   * @return {@code Completes>}
   */
   Completes> maybeActorOf(final Class protocol, final Address address);
}