org.restcomm.media.network.deprecated.channel

Class PacketHandlerPipeline

java.lang.Object

org.restcomm.media.network.deprecated.channel.PacketHandlerPipeline

public class PacketHandlerPipeline
extends Object

Pipeline that selects a capable PacketHandler to process incoming packets.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors

Constructor and Description
PacketHandlerPipeline()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addHandler(PacketHandler handler) Registers a new packet handler in the pipeline. Cannot register same handler twice.
boolean	contains(PacketHandler handler) Checks whether a certain handler is already registered in the pipeline.
int	count() Gets the number of handlers registered in the pipeline.
PacketHandler	getHandler(byte[] packet) Gets the protocol handler capable of processing the packet.
protected List<PacketHandler>	getHandlers() Gets a copy of the handlers registered in the pipeline.
boolean	removeHandler(PacketHandler handler) Removes an existing packet handler from the pipeline.

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketHandlerPipeline

public PacketHandlerPipeline()

Method Detail

addHandler

public boolean addHandler(PacketHandler handler)

Registers a new packet handler in the pipeline.
Cannot register same handler twice.

Parameters:

handler - The handler to be registered.

Returns:

Whether the handler was successfully registered or not.

removeHandler

public boolean removeHandler(PacketHandler handler)

Removes an existing packet handler from the pipeline.

Parameters:

handler - The handler to be removed

Returns:

Returns true if the handler is removed successfully. Returns false, if the handler is not registered in the pipeline.

count

public int count()

Gets the number of handlers registered in the pipeline.

Returns:

The number of registered handlers.

contains

public boolean contains(PacketHandler handler)

Checks whether a certain handler is already registered in the pipeline.

Parameters:

handler - The handler to look for

Returns:

true if the handler is registered. Returns false, otherwise.

getHandler

public PacketHandler getHandler(byte[] packet)

Gets the protocol handler capable of processing the packet.

Parameters:

packet - The packet to be processed

Returns:

The protocol handler capable of processing the packet.
Returns null in case no capable handler exists.

getHandlers

protected List<PacketHandler> getHandlers()

Gets a copy of the handlers registered in the pipeline.

Returns:

The list of handlers registered.