mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-16 08:34:50 +02:00
63d52f6eaa
both serve the same purpose: As callback for Packets. There is no need to have both, so remace PacketInterceptor and let PacketListener take its place. Some classes like ChatStateManager can now use MessageListener as interceptor callback, which is more convenient.
54 lines
1.9 KiB
Java
54 lines
1.9 KiB
Java
/**
|
|
*
|
|
* Copyright 2003-2007 Jive Software.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smack;
|
|
|
|
import org.jivesoftware.smack.SmackException.NotConnectedException;
|
|
import org.jivesoftware.smack.packet.Packet;
|
|
|
|
/**
|
|
* Provides a mechanism to listen for packets that pass a specified filter.
|
|
* This allows event-style programming -- every time a new packet is found,
|
|
* the {@link #processPacket(Packet)} method will be called. This is the
|
|
* opposite approach to the functionality provided by a {@link PacketCollector}
|
|
* which lets you block while waiting for results.
|
|
* <p>
|
|
* Additionally you are able to intercept Packets that are going to be send and
|
|
* make modifications to them. You can register a PacketListener as interceptor
|
|
* by using {@link XMPPConnection#addPacketInterceptor(PacketListener,
|
|
* org.jivesoftware.smack.filter.PacketFilter)}
|
|
* </p>
|
|
*
|
|
* @see XMPPConnection#addPacketListener(PacketListener, org.jivesoftware.smack.filter.PacketFilter)
|
|
* @author Matt Tucker
|
|
*/
|
|
public interface PacketListener {
|
|
|
|
/**
|
|
* Process the next packet sent to this packet listener.
|
|
* <p>
|
|
* A single thread is responsible for invoking all listeners, so
|
|
* it's very important that implementations of this method not block
|
|
* for any extended period of time.
|
|
* </p>
|
|
*
|
|
* @param packet the packet to process.
|
|
*/
|
|
public void processPacket(Packet packet) throws NotConnectedException;
|
|
|
|
}
|