package org.red5.server.adapter;
/*
* RED5 Open Source Flash Server - http://www.osflash.org/red5
*
* Copyright (c) 2006-2009 by respective authors (see below). All rights reserved.
*
* 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
*/
import org.red5.server.api.IClient;
import org.red5.server.api.IConnection;
import org.red5.server.api.IScope;
/**
* IApplication provides lifecycle methods that most communication applications
* will use. This interface defines the methods that are called by Red5 through
* an applications life.
*
* @author Dominick Accattato
*
*/
public interface IApplication {
/**
* Called once when application or room starts
*
* @param app Application or room level scope. See
* {@link org.red5.server.api.IScope} for details
* @return <code>true</code> continues application run, <code>false</code>
* terminates
*/
public boolean appStart(IScope app);
/**
* Called per each client connect
*
* @param conn Connection object used to provide basic connection methods.
* See {@link org.red5.server.api.IConnection}
* @param params List of params sent from client with NetConnection.connect
* call
* @return <code>true</code> accepts the connection, <code>false</code>
* rejects it
*/
public boolean appConnect(IConnection conn, Object[] params);
/**
* Called every time client joins app level scope
*
* @param client Client object
* @param app Scope object
* @return <code>true</code> accepts the client, <code>false</code>
* rejects it
*/
public boolean appJoin(IClient client, IScope app);
/**
* Called every time client disconnects from the application
*
* @param conn Connection object See {@link org.red5.server.api.IConnection}
*/
public void appDisconnect(IConnection conn);
/**
* Called every time client leaves the application scope
*
* @param client Client object
* @param app Scope object
*/
public void appLeave(IClient client, IScope app);
/**
* Called on application stop
*
* @param app Scope object
*/
public void appStop(IScope app);
/**
* Called on application room start
*
* @param room Scope object
* @return <code>true</code> if scope can be started, <code>false</code>
* otherwise
*/
public boolean roomStart(IScope room);
/**
* Called every time client connects to the room
*
* @param conn Connection object
* @param params List of params sent from client with NetConnection.connect
* call
* @return <code>true</code> accepts the connection, <code>false</code>
* rejects it
*/
public boolean roomConnect(IConnection conn, Object[] params);
/**
* Called when user joins room scope
*
* @param client Client object
* @param room Scope object
* @return <code>true</code> accepts the client, <code>false</code>
* rejects it
*/
public boolean roomJoin(IClient client, IScope room);
/**
* Called when client disconnects from room scope
*
* @param conn Connection object used to provide basic connection methods.
* See {@link org.red5.server.api.IConnection}
*/
public void roomDisconnect(IConnection conn);
/**
* Called when user leaves room scope
*
* @param client Client object
* @param room Scope object
*/
public void roomLeave(IClient client, IScope room);
/**
* Called on room scope stop
*
* @param room Scope object
*/
public void roomStop(IScope room);
}