PipeConnectionEvent.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.messaging;

import java.util.ArrayList;
import java.util.EventObject;
import java.util.List;
import java.util.Map;

/**
 * Event object corresponds to the connect/disconnect events
 * among providers/consumers and pipes.
 *  
 * @author The Red5 Project (red5@osflash.org)
 * @author Steven Gong (steven.gong@gmail.com)
 */
public class PipeConnectionEvent extends EventObject {

	private static final long serialVersionUID = 9078843765378168072L;

	private List<Runnable> taskList = new ArrayList<Runnable>(3);

	/**
	 * A provider connects as pull mode.
	 */
	public static final int PROVIDER_CONNECT_PULL = 0;

	/**
	 * A provider connects as push mode.
	 */
	public static final int PROVIDER_CONNECT_PUSH = 1;

	/**
	 * A provider disconnects.
	 */
	public static final int PROVIDER_DISCONNECT = 2;

	/**
	 * A consumer connects as pull mode.
	 */
	public static final int CONSUMER_CONNECT_PULL = 3;

	/**
	 * A consumer connects as push mode.
	 */
	public static final int CONSUMER_CONNECT_PUSH = 4;

	/**
	 * A consumer disconnects.
	 */
	public static final int CONSUMER_DISCONNECT = 5;

	/**
	 * Provider
	 */
	private transient IProvider provider;

	/**
	 * Consumer
	 */
	private transient IConsumer consumer;

	/**
	 * Event type
	 */
	private int type;

	/**
	 * Parameters map
	 */
	private Map<String, Object> paramMap;

	/**
	 * Construct an object with the specific pipe as the
	 * <tt>source</tt>
	 * @param source A pipe that triggers this event.
	 */
	public PipeConnectionEvent(Object source) {
		super(source);
	}

	/**
	 * Return pipe connection provider
	 * @return          Provider
	 */
	public IProvider getProvider() {
		return provider;
	}

	/**
	 * Setter for pipe connection provider
	 * @param provider  Provider
	 */
	public void setProvider(IProvider provider) {
		this.provider = provider;
	}

	/**
	 * Return pipe connection consumer
	 * @return          Consumer
	 */
	public IConsumer getConsumer() {
		return consumer;
	}

	/**
	 * Setter for pipe connection consumer
	 * @param consumer  Consumer
	 */
	public void setConsumer(IConsumer consumer) {
		this.consumer = consumer;
	}

	/**
	 * Return event type
	 * @return             Event type
	 */
	public int getType() {
		return type;
	}

	/**
	 * Setter for event type
	 * @param type         Event type
	 */
	public void setType(int type) {
		this.type = type;
	}

	/**
	 * Return event parameters as Map
	 * @return             Event parameters as Map
	 */
	public Map<String, Object> getParamMap() {
		return paramMap;
	}

	/**
	 * Setter for event parameters map
	 * @param paramMap     Event parameters as Map
	 */
	public void setParamMap(Map<String, Object> paramMap) {
		this.paramMap = paramMap;
	}

	/**
	 * Add task to list
	 * @param task     Task to add
	 */
	public void addTask(Runnable task) {
		taskList.add(task);
	}

	/**
	 * Return list of tasks
	 * @return       List of tasks
	 */
	List<Runnable> getTaskList() {
		return taskList;
	}
}