org.restcomm.media.network.deprecated.channel

Interface PacketHandler

All Superinterfaces:

Comparable<PacketHandler>

public interface PacketHandler
extends Comparable<PacketHandler>

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(byte[] packet) Checks whether the handler can process the incoming packet or not.
boolean	canHandle(byte[] packet, int dataLength, int offset)
int	getPipelinePriority() Gets the priority of the handler in the pipeline. The priority affects the place of the handler in the pipeline.
byte[]	handle(byte[] packet, InetSocketAddress localPeer, InetSocketAddress remotePeer) Processes the packet and provides a suitable answer.
byte[]	handle(byte[] packet, int dataLength, int offset, InetSocketAddress localPeer, InetSocketAddress remotePeer) Processes the packet and provides a suitable answer.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

canHandle

boolean canHandle(byte[] packet)

Checks whether the handler can process the incoming packet or not.

Parameters:

packet - The packet to be processed.

Returns:

true, if the packet can be handled. false, otherwise.

canHandle

boolean canHandle(byte[] packet,
                int dataLength,
                int offset)

handle

byte[] handle(byte[] packet,
            InetSocketAddress localPeer,
            InetSocketAddress remotePeer)
              throws PacketHandlerException

Processes the packet and provides a suitable answer.

Parameters:

packet - The packet to be processed.

localPeer - The local peer who received the packet

remotePeer - The remote peer who sent the packet

Returns:

The answer to be sent to the remote peer as response to the incoming packet.

Throws:

PacketHandlerException - When the handler cannot process the packet.

handle

byte[] handle(byte[] packet,
            int dataLength,
            int offset,
            InetSocketAddress localPeer,
            InetSocketAddress remotePeer)
              throws PacketHandlerException

Processes the packet and provides a suitable answer.

Parameters:

packet - The packet to be processed.

dataLength - The length of the data to be read.

offset - The initial position to start reading data from.

localPeer - The local peer who received the packet

remotePeer - The remote peer who sent the packet

Returns:

The answer to be sent to the remote peer as response to the incoming packet.

Throws:

PacketHandlerException - When the handler cannot process the packet.

getPipelinePriority

int getPipelinePriority()

Gets the priority of the handler in the pipeline.
The priority affects the place of the handler in the pipeline. This can affect performance as handlers with higher priority will be queried first when a packet arrives.

Returns:

The priority of the handler