vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-09 09:09:38 +02:00
Code Issues Releases Wiki Activity

Substitute 'packet' with 'stanza(/packet)' in javadoc

Browse source
This commit is contained in:
Florian Schmaus 2015-03-21 09:36:28 +01:00
parent 0ca4e8b72a
commit 5e86db4f80
168 changed files with 650 additions and 650 deletions
Download patch file Download diff file Expand all files Collapse all files

4
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleManager.java
View file

@ -437,7 +437,7 @@ public class JingleManager implements JingleSessionListener {
}
/**
* Register the listenerJingles, waiting for a Jingle packet that tries to
* Register the listenerJingles, waiting for a Jingle stanza(/packet) that tries to
* establish a new session.
*/
private void initJingleSessionRequestListeners() {
@ -489,7 +489,7 @@ public class JingleManager implements JingleSessionListener {
/**
* Activates the listenerJingles on a Jingle session request.
*
* @param initJin the packet that must be passed to the jingleSessionRequestListener.
* @param initJin the stanza(/packet) that must be passed to the jingleSessionRequestListener.
*/
void triggerSessionRequested(Jingle initJin) {

8
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleNegotiator.java
View file

@ -204,7 +204,7 @@ public abstract class JingleNegotiator {
/**
* Dispatch an incoming packet.
*
* The negotiators form a tree relationship that roughly matches the Jingle packet format:
* The negotiators form a tree relationship that roughly matches the Jingle stanza(/packet) format:
*
* JingleSession
* Content Negotiator
@ -222,15 +222,15 @@ public abstract class JingleNegotiator {
* <description>
* <transport>
*
* This way, each segment of a Jingle packet has a corresponding negotiator that know how to deal with that
* This way, each segment of a Jingle stanza(/packet) has a corresponding negotiator that know how to deal with that
* part of the Jingle packet. It also allows us to support Jingle packets of arbitraty complexity.
*
* Each parent calls dispatchIncomingPacket for each of its children. The children then pass back a List<> of
* results that will get sent when we reach the top level negotiator (JingleSession).
*
* @param iq the packet received
* @param iq the stanza(/packet) received
* @param id the ID of the response that will be sent
* @return the new packet to send (either a Jingle or an IQ error).
* @return the new stanza(/packet) to send (either a Jingle or an IQ error).
* @throws XMPPException
*/
public abstract List<IQ> dispatchIncomingPacket(IQ iq, String id) throws XMPPException, SmackException;

34
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSession.java
View file

@ -266,14 +266,14 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
/**
* Process and respond to an incoming packet. <p/> This method is called
* from the packet listener dispatcher when a new packet has arrived. The
* method is responsible for recognizing the packet type and, depending on
* from the stanza(/packet) listener dispatcher when a new stanza(/packet) has arrived. The
* method is responsible for recognizing the stanza(/packet) type and, depending on
* the current state, delivering it to the right event handler and wait for
* a response. The response will be another Jingle packet that will be sent
* a response. The response will be another Jingle stanza(/packet) that will be sent
* to the other end point.
*
* @param iq
* the packet received
* the stanza(/packet) received
* @throws XMPPException
* @throws SmackException
*/
@ -336,12 +336,12 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
/**
* Dispatch an incoming packet. The method is responsible for recognizing
* the packet type and, depending on the current state, delivering the
* packet to the right event handler and wait for a response.
* the stanza(/packet) type and, depending on the current state, delivering the
* stanza(/packet) to the right event handler and wait for a response.
*
* @param iq
* the packet received
* @return the new Jingle packet to send.
* the stanza(/packet) received
* @return the new Jingle stanza(/packet) to send.
* @throws XMPPException
* @throws SmackException
*/
@ -414,7 +414,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
* reponse, using the session information we have.
*
* @param jout
* the Jingle packet we want to complete and send
* the Jingle stanza(/packet) we want to complete and send
* @throws NotConnectedException
*/
public Jingle sendFormattedJingle(Jingle jout) throws NotConnectedException {
@ -427,9 +427,9 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
* incoming packet.
*
* @param iq
* The Jingle packet we are responing to
* The Jingle stanza(/packet) we are responing to
* @param jout
* the Jingle packet we want to complete and send
* the Jingle stanza(/packet) we want to complete and send
* @throws NotConnectedException
*/
public Jingle sendFormattedJingle(IQ iq, Jingle jout) throws NotConnectedException {
@ -647,7 +647,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Remove the packet listener used for processing packet.
* Remove the stanza(/packet) listener used for processing packet.
*/
protected void removeAsyncPacketListener() {
if (packetListener != null) {
@ -658,8 +658,8 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
}
/**
* Install the packet listener. The listener is responsible for responding
* to any packet that we receive...
* Install the stanza(/packet) listener. The listener is responsible for responding
* to any stanza(/packet) that we receive...
*/
protected void updatePacketListener() {
removeAsyncPacketListener();
@ -1017,9 +1017,9 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
* incoming packet.
*
* @param iq
* The Jingle packet we are responing to
* The Jingle stanza(/packet) we are responing to
* @param jingleError
* the IQ packet we want to complete and send
* the IQ stanza(/packet) we want to complete and send
*/
public IQ createJingleError(IQ iq, JingleError jingleError) {
IQ errorPacket = null;
@ -1124,7 +1124,7 @@ public class JingleSession extends JingleNegotiator implements MediaReceivedList
/**
* When we initiate a session we need to start a bunch of negotiators right after we receive the result
* packet for our session-initiate. This is where we start them.
* stanza(/packet) for our session-initiate. This is where we start them.
*
*/
private void startNegotiators() {

4
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/JingleSessionRequest.java
View file

@ -27,7 +27,7 @@ import org.jivesoftware.smackx.jingleold.packet.Jingle;
* A Jingle session request.
* <p/>
* This class is a facade of a received Jingle request. The user can have direct
* access to the Jingle packet (<i>JingleSessionRequest.getJingle() </i>) of
* access to the Jingle stanza(/packet) (<i>JingleSessionRequest.getJingle() </i>) of
* the request or can use the convencience methods provided by this class.
*
* @author Alvaro Saurin
@ -75,7 +75,7 @@ public class JingleSessionRequest {
}
/**
* Returns the Jingle packet that was sent by the requester which contains
* Returns the Jingle stanza(/packet) that was sent by the requester which contains
* the parameters of the session.
*/
public Jingle getJingle() {

8
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/media/MediaNegotiator.java
View file

@ -95,12 +95,12 @@ public class MediaNegotiator extends JingleNegotiator {
/**
* Dispatch an incoming packet. The method is responsible for recognizing
* the packet type and, depending on the current state, delivering the
* packet to the right event handler and wait for a response.
* the stanza(/packet) type and, depending on the current state, delivering the
* stanza(/packet) to the right event handler and wait for a response.
*
* @param iq
* the packet received
* @return the new Jingle packet to send.
* the stanza(/packet) received
* @return the new Jingle stanza(/packet) to send.
* @throws XMPPException
* @throws NotConnectedException
*/

4
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/mediaimpl/jmf/AudioChannel.java
View file

@ -307,11 +307,11 @@ public class AudioChannel {
}
/**
* Get the best packet size for a given codec and a codec rate
* Get the best stanza(/packet) size for a given codec and a codec rate
*
* @param codecFormat
* @param milliseconds
* @return the best packet size
* @return the best stanza(/packet) size
* @throws IllegalArgumentException
*/
private int getPacketSize(Format codecFormat, int milliseconds) throws IllegalArgumentException {

4
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/DatagramListener.java
View file

@ -27,9 +27,9 @@ public interface DatagramListener {
/**
* Called when a datagram is received. If the method returns false, the
* packet MUST NOT be resent from the received Channel.
* stanza(/packet) MUST NOT be resent from the received Channel.
*
* @param datagramPacket the datagram packet received.
* @param datagramPacket the datagram stanza(/packet) received.
* @return ?
*/
public boolean datagramReceived(DatagramPacket datagramPacket);

16
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/RTPBridge.java
View file

@ -39,7 +39,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* RTPBridge IQ Packet used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT.
* RTPBridge IQ Stanza(/Packet) used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT.
* This Jingle Bridge has all the needed information to establish a full UDP Channel (Send and Receive) between two parties.
* <i>This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport.</i>
* <p/>
@ -69,17 +69,17 @@ public class RTPBridge extends IQ {
}
/**
* Element name of the packet extension.
* Element name of the stanza(/packet) extension.
*/
public static final String NAME = "rtpbridge";
/**
* Element name of the packet extension.
* Element name of the stanza(/packet) extension.
*/
public static final String ELEMENT_NAME = "rtpbridge";
/**
* Namespace of the packet extension.
* Namespace of the stanza(/packet) extension.
*/
public static final String NAMESPACE = "http://www.jivesoftware.com/protocol/rtpbridge";
@ -120,7 +120,7 @@ public class RTPBridge extends IQ {
}
/**
* Creates a RTPBridge Packet without Session ID
* Creates a RTPBridge Stanza(/Packet) without Session ID
*/
public RTPBridge() {
super(ELEMENT_NAME, NAMESPACE);
@ -154,7 +154,7 @@ public class RTPBridge extends IQ {
}
/**
* Get the Session ID of the Packet (usually same as Jingle Session ID)
* Get the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID)
*
* @return the session ID
*/
@ -163,7 +163,7 @@ public class RTPBridge extends IQ {
}
/**
* Set the Session ID of the Packet (usually same as Jingle Session ID)
* Set the Session ID of the Stanza(/Packet) (usually same as Jingle Session ID)
*
* @param sid
*/
@ -318,7 +318,7 @@ public class RTPBridge extends IQ {
/**
* IQProvider for RTP Bridge packets.
* Parse receive RTPBridge packet to a RTPBridge instance
* Parse receive RTPBridge stanza(/packet) to a RTPBridge instance
*
* @author Thiago Rocha
*/

10
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/STUN.java
View file

@ -36,7 +36,7 @@ import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/**
* STUN IQ Packet used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT.
* STUN IQ Stanza(/Packet) used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT.
* <p/>
* High Level Usage Example:
* <p/>
@ -53,17 +53,17 @@ public class STUN extends SimpleIQ {
private String publicIp = null;
/**
* Element name of the packet extension.
* Element name of the stanza(/packet) extension.
*/
public static final String DOMAIN = "stun";
/**
* Element name of the packet extension.
* Element name of the stanza(/packet) extension.
*/
public static final String ELEMENT_NAME = "query";
/**
* Namespace of the packet extension.
* Namespace of the stanza(/packet) extension.
*/
public static final String NAMESPACE = "google:jingleinfo";
@ -107,7 +107,7 @@ public class STUN extends SimpleIQ {
/**
* IQProvider for RTP Bridge packets.
* Parse receive RTPBridge packet to a RTPBridge instance
* Parse receive RTPBridge stanza(/packet) to a RTPBridge instance
*
* @author Thiago Rocha
*/

12
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/nat/TransportNegotiator.java
View file

@ -45,7 +45,7 @@ import org.jivesoftware.smackx.jingleold.packet.JingleTransport.JingleTransportC
* <p/>
* <p/>
* This class is responsible for managing the transport negotiation process,
* handling all the packet interchange and the stage control.
* handling all the stanza(/packet) interchange and the stage control.
*
* @author Alvaro Saurin <alvaro.saurin@gmail.com>
*/
@ -543,7 +543,7 @@ public abstract class TransportNegotiator extends JingleNegotiator {
}
/**
* Create a Jingle packet where we announce our transport candidates.
* Create a Jingle stanza(/packet) where we announce our transport candidates.
*
* @throws XMPPException
* @throws SmackException
@ -585,11 +585,11 @@ public abstract class TransportNegotiator extends JingleNegotiator {
/**
* Dispatch an incoming packet. The method is responsible for recognizing
* the packet type and, depending on the current state, deliverying the
* packet to the right event handler and wait for a response.
* the stanza(/packet) type and, depending on the current state, deliverying the
* stanza(/packet) to the right event handler and wait for a response.
*
* @param iq the packet received
* @return the new Jingle packet to send.
* @param iq the stanza(/packet) received
* @return the new Jingle stanza(/packet) to send.
* @throws XMPPException
* @throws SmackException
*/

6
smack-jingle-old/src/main/java/org/jivesoftware/smackx/jingleold/packet/Jingle.java
View file

@ -179,7 +179,7 @@ public class Jingle extends IQ {
* Returns the XML element name of the extension sub-packet root element.
* Always returns "jingle"
*
* @return the XML element name of the packet extension.
* @return the XML element name of the stanza(/packet) extension.
*/
public static String getElementName() {
return NODENAME;
@ -188,7 +188,7 @@ public class Jingle extends IQ {
/**
* Returns the XML namespace of the extension sub-packet root element.
*
* @return the XML namespace of the packet extension.
* @return the XML namespace of the stanza(/packet) extension.
*/
public static String getNamespace() {
return NAMESPACE;
@ -319,7 +319,7 @@ public class Jingle extends IQ {
}
/**
* Get a hash key for the session this packet belongs to.
* Get a hash key for the session this stanza(/packet) belongs to.
*
* @param sid The session id
* @param initiator The initiator