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

Go to download
//
// $Id: BureauService.java 6682 2011-07-07 21:10:49Z charlie $
//
// 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.presents.client.InvocationService;
import com.threerings.presents.data.ClientObject;

/**
 * Interface for the bureau to communicate with the server.
 */
public interface BureauService extends InvocationService
{
    /**
     * Notifies the server that the bureau is up and running and ready to receive
     * requests via the BureauReceiver.
     * @see BureauReceiver
     */
    void bureauInitialized (String bureauId);

    /**
     * Notifies the server that this bureau has encountered a critical error and needs to be shut
     * down.
     */
    void bureauError (String message);

    /**
     * Notify the server that a previosuly requested agent is now created and ready to use.
     * @see BureauReceiver#createAgent
     */
    void agentCreated (int agentId);

    /**
     * Notify the server that a previosuly requested agent could not be created.
     * @see BureauReceiver#createAgent
     */
    void agentCreationFailed (int agentId);

    /**
     * Notify the server that an agent is no longer running. Normally called in response
     * to a call to destroyAgent
     * @see BureauReceiver#destroyAgent
     */
    void agentDestroyed (int agentId);
}