com.threerings.bureau.client.Agent Maven / Gradle / Ivy

Go to download
//
// $Id: Agent.java 6407 2011-01-01 05:02:21Z dhoover $
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2011 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.bureau.client;

import com.threerings.bureau.data.AgentObject;

/**
 * Represents an agent running within a bureau client.
 */
public abstract class Agent
{
    /**
     * Initializes the Agent with the distributed agent object.
     */
    public void init (AgentObject agentObj)
    {
        _agentObj = agentObj;
    }

    /**
     * Starts the code running in the agent.
     */
    public abstract void start ();

    /**
     * Stops the code running in the agent.
     */
    public abstract void stop ();

    /**
     * The shared agent object.
     */
    protected AgentObject _agentObj;
}