abs.ixi.client.core

Interface PacketForwarder

All Known Subinterfaces:

Reader

All Known Implementing Classes:

AbstractPacketForwarder, ChatManager, PresenceManager, UserManager, XMPPPacketReader, XMPPStreamManager

public interface PacketForwarder

PacketForwarder interface enables hierarchical packet bubble up process. In order to receive packets, any PacketCollector can subscribe to a PacketForwarder. A PacketForwarder forwards each packet to all the subscribed PacketCollectors.

PacketCollector and PacketForwarder together can be used create a hierarchical packet filtering and processing unit. A PacketForwarder forwards after applying a its filters on the incoming packets.

Method Summary

Modifier and Type	Method and Description
void	addPacketCollector(Class<? extends Packet> clz, PacketCollector collector) Add a PacketCollector to this PacketForwarder's list of PacketCollectors.
void	addPacketCollector(PacketCollector collector) Add a PacketCollector to this PacketForwarder's list of PacketCollectors.
void	forwardPacket(Packet packet) Forwards packet to registered packet collectors
void	removePacketCollector(Class<? extends Packet> clz, PacketCollector collector) Remove the given PacketCollector from this PacketForwarder list.
void	removePacketCollector(PacketCollector collector) Remove the given PacketCollector from this PacketForwarder list for all packets.

Method Detail

addPacketCollector

void addPacketCollector(PacketCollector collector)

Add a PacketCollector to this PacketForwarder's list of PacketCollectors. The collector will receive all type of packets which this forwarder could not consume.

Parameters:

collector - PacketCollector instance

addPacketCollector

void addPacketCollector(Class<? extends Packet> clz,
                        PacketCollector collector)

Add a PacketCollector to this PacketForwarder's list of PacketCollectors. This forwarder will forward the packets of type class specified to the specified collector.

Parameters:

clz - Class of the packet for which collector is subscribing

collector - PacketCollector instance

removePacketCollector

void removePacketCollector(PacketCollector collector)

Remove the given PacketCollector from this PacketForwarder list for all packets.

Parameters:

collector - PacketCollector to be removed

removePacketCollector

void removePacketCollector(Class<? extends Packet> clz,
                           PacketCollector collector)

Remove the given PacketCollector from this PacketForwarder list. This method will remove the collector for packets of type class specified.

Parameters:

clz - Class for which the collector subscription has to be removed

collector - PacketCollector instance

forwardPacket

void forwardPacket(Packet packet)

Forwards packet to registered packet collectors

Parameters:

packet - Packet instance