IRTMPConnManager.java

/*
 * RED5 Open Source Flash Server - http://code.google.com/p/red5/
 * 
 * Copyright 2006-2012 by respective authors (see below). All rights reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.red5.server.net.rtmp;

import java.util.Collection;

public interface IRTMPConnManager {
	
	/**
	 * Returns a connection matching the given client id.
	 * 
	 * @param clientId
	 * @return connection
	 */	
	RTMPConnection getConnection(int clientId);

	/**
	 * Returns a connection matching the given session id.
	 * 
	 * @param sessionId
	 * @return connection
	 */	
	RTMPConnection getConnectionBySessionId(String sessionId);

	/**
	 * Creates a connection based on the given RTMPConnection class.
	 * 
	 * @param connCls
	 * @return connection
	 */
	RTMPConnection createConnection(Class<?> connCls);

	/**
	 * Removes a connection matching the client id specified. If found, the connection
	 * will be returned.
	 * 
	 * @param clientId
	 * @return connection
	 */	
	RTMPConnection removeConnection(int clientId);

	/**
	 * Removes all the connections from the set.
	 * @return connections
	 */	
	Collection<RTMPConnection> removeConnections();
	
}