com.droidkit.actors.ActorRef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of actors Show documentation
DroidKit Actors is simple actor model implementation for java and Android
There is a newer version: 0.6.1
package com.droidkit.actors;

import com.droidkit.actors.mailbox.AbsActorDispatcher;
import com.droidkit.actors.mailbox.ActorEndpoint;

import java.util.UUID;

/**
 * Reference to Actor that allows to send messages to real Actor
 *
 * @author Stepan Ex3NDR Korshakov ([email protected])
 */
public class ActorRef {
    private ActorSystem system;
    private AbsActorDispatcher dispatcher;
    private UUID uuid;
    private String path;
    private ActorEndpoint endpoint;

    public UUID getUuid() {
        return uuid;
    }

    public String getPath() {
        return path;
    }

    public ActorSystem system() {
        return system;
    }

    public ActorEndpoint getEndpoint() {
        return endpoint;
    }

    /**
     * INTERNAL API
     * Creating actor reference
     *
     * @param system     actor system
     * @param dispatcher dispatcher of actor
     * @param path       path of actor
     * @param uuid       uuid of actor
     */
    public ActorRef(ActorEndpoint endpoint, ActorSystem system, AbsActorDispatcher dispatcher, UUID uuid, String path) {
        this.endpoint = endpoint;
        this.system = system;
        this.dispatcher = dispatcher;
        this.uuid = uuid;
        this.path = path;
    }

    /**
     * Send message with empty sender
     *
     * @param message message
     */
    public void send(Object message) {
        send(message, null);
    }

    /**
     * Send message with specified sender
     *
     * @param message message
     * @param sender  sender
     */
    public void send(Object message, ActorRef sender) {
        send(message, 0, sender);
    }

    /**
     * Send message with empty sender and delay
     *
     * @param message message
     * @param delay   delay
     */
    public void send(Object message, long delay) {
        send(message, delay, null);
    }

    /**
     * Send message
     *
     * @param message message
     * @param delay   delay
     * @param sender  sender
     */
    public void send(Object message, long delay, ActorRef sender) {
        dispatcher.sendMessage(endpoint, message, ActorTime.currentTime() + delay, sender);
    }

    /**
     * Send message once
     *
     * @param message message
     */
    public void sendOnce(Object message) {
        send(message, null);
    }

    /**
     * Send message once
     *
     * @param message message
     * @param sender  sender
     */
    public void sendOnce(Object message, ActorRef sender) {
        sendOnce(message, 0, sender);
    }

    /**
     * Send message once
     *
     * @param message message
     * @param delay   delay
     */
    public void sendOnce(Object message, long delay) {
        sendOnce(message, delay, null);
    }

    /**
     * Send message once
     *
     * @param message message
     * @param delay   delay
     * @param sender  sender
     */
    public void sendOnce(Object message, long delay, ActorRef sender) {
        dispatcher.sendMessageOnce(endpoint, message, ActorTime.currentTime() + delay, sender);
    }
}