org.jivesoftware.smack
Class PacketCollector

java.lang.Object
  org.jivesoftware.smack.PacketCollector

public class PacketCollector
extends java.lang.Object

Provides a mechanism to collect packets into a result queue that pass a specified filter. The collector lets you perform blocking and polling operations on the result queue. So, a PacketCollector is more suitable to use than a PacketListener when you need to wait for a specific result.

Each packet collector will queue up a configured number of packets for processing before older packets are automatically dropped. The default number is retrieved by SmackConfiguration.getPacketCollectorSize().

Author:

Matt Tucker

See Also:

Connection.createPacketCollector(PacketFilter)

Method Summary

void	cancel() Explicitly cancels the packet collector so that no more results are queued up.
PacketFilter	getPacketFilter() Returns the packet filter associated with this packet collector.
Packet	nextResult() Returns the next available packet.
Packet	nextResult(long timeout) Returns the next available packet.
Packet	pollResult() Polls to see if a packet is currently available and returns it, or immediately returns null if no packets are currently in the result queue.

Methods inherited from class java.lang.Object

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

Method Detail

cancel

public void cancel()

Explicitly cancels the packet collector so that no more results are queued up. Once a packet collector has been cancelled, it cannot be re-enabled. Instead, a new packet collector must be created.

getPacketFilter

public PacketFilter getPacketFilter()

Returns the packet filter associated with this packet collector. The packet filter is used to determine what packets are queued as results.

Returns:

the packet filter.

pollResult

public Packet pollResult()

Polls to see if a packet is currently available and returns it, or immediately returns null if no packets are currently in the result queue.

Returns:

the next packet result, or null if there are no more results.

nextResult

public Packet nextResult()

Returns the next available packet. The method call will block (not return) until a packet is available.

Returns:

the next available packet.

nextResult

public Packet nextResult(long timeout)

Returns the next available packet. The method call will block (not return) until a packet is available or the timeout has elapased. If the timeout elapses without a result, null will be returned.

Parameters:

timeout - the amount of time to wait for the next packet (in milleseconds).

Returns:

the next available packet.