public class PacketCollector extends Object
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().
Connection.createPacketCollector(PacketFilter)| Modifier | Constructor and Description |
|---|---|
protected |
PacketCollector(Connection conection,
PacketFilter packetFilter)
Creates a new packet collector.
|
protected |
PacketCollector(Connection conection,
PacketFilter packetFilter,
int maxSize)
Creates a new packet collector.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
org.xmpp.packet.Packet |
nextResult()
Returns the next available packet.
|
org.xmpp.packet.Packet |
nextResult(long timeout)
Returns the next available packet.
|
org.xmpp.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.
|
protected void |
processPacket(org.xmpp.packet.Packet packet)
Processes a packet to see if it meets the criteria for this packet
collector.
|
protected PacketCollector(Connection conection, PacketFilter packetFilter)
conection - the connection the collector is tied to.packetFilter - determines which packets will be returned by this collector.protected PacketCollector(Connection conection, PacketFilter packetFilter, int maxSize)
conection - the connection the collector is tied to.packetFilter - determines which packets will be returned by this collector.maxSize - the maximum number of packets that will be stored in the
collector.public void cancel()
public PacketFilter getPacketFilter()
public org.xmpp.packet.Packet pollResult()
public org.xmpp.packet.Packet nextResult()
public org.xmpp.packet.Packet nextResult(long timeout)
timeout - the amount of time to wait for the next packet (in
milleseconds).protected void processPacket(org.xmpp.packet.Packet packet)
packet - the packet to process.Copyright © 2014. All Rights Reserved.