org.red5.server.messaging

Class PipeConnectionEvent

java.lang.Object

java.util.EventObject

org.red5.server.messaging.PipeConnectionEvent

All Implemented Interfaces:

Serializable

public class PipeConnectionEvent
extends EventObject

Event object corresponds to the connect/disconnect events among providers/consumers on pipes. This object is immutable except for the parameter map and tasks.

Author:

The Red5 Project, Steven Gong (steven.gong@gmail.com), Paul Gregoire (mondain@gmail.com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipeConnectionEvent.EventType Pipe connection event type

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
void	addTask(Runnable task) Add task to list
static PipeConnectionEvent	build(AbstractPipe source, PipeConnectionEvent.EventType type, IConsumer consumer, Map<String,Object> paramMap) Builds a PipeConnectionEvent with a source pipe and consumer.
static PipeConnectionEvent	build(AbstractPipe source, PipeConnectionEvent.EventType type, IProvider provider, Map<String,Object> paramMap) Builds a PipeConnectionEvent with a source pipe and provider.
IConsumer	getConsumer() Return pipe connection consumer
Map<String,Object>	getParamMap() Return event parameters as Map
IProvider	getProvider() Return pipe connection provider
PipeConnectionEvent.EventType	getType() Return event type
void	setParamMap(Map<String,Object> paramMap) Setter for event parameters map

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getProvider

public IProvider getProvider()

Return pipe connection provider

Returns:

Provider

getConsumer

public IConsumer getConsumer()

Return pipe connection consumer

Returns:

Consumer

getType

public PipeConnectionEvent.EventType getType()

Return event type

Returns:

Event type

getParamMap

public Map<String,Object> getParamMap()

Return event parameters as Map

Returns:

Event parameters as Map

setParamMap

public void setParamMap(Map<String,Object> paramMap)

Setter for event parameters map

Parameters:

paramMap - Event parameters as Map

addTask

public void addTask(Runnable task)

Add task to list

Parameters:

task - Task to add

build

public static final PipeConnectionEvent build(AbstractPipe source,
                                              PipeConnectionEvent.EventType type,
                                              IConsumer consumer,
                                              Map<String,Object> paramMap)

Builds a PipeConnectionEvent with a source pipe and consumer.

Parameters:

source - pipe that triggers this event

type - event type

consumer - the consumer

paramMap - parameters map

Returns:

event

build

public static final PipeConnectionEvent build(AbstractPipe source,
                                              PipeConnectionEvent.EventType type,
                                              IProvider provider,
                                              Map<String,Object> paramMap)

Builds a PipeConnectionEvent with a source pipe and provider.

Parameters:

source - pipe that triggers this event

type - event type

provider - the provider

paramMap - parameters map

Returns:

event