|
Smack | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.smack.packet.Packet org.jivesoftware.smack.packet.IQ org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream
public class Bytestream
A packet representing part of a SOCKS5 Bytestream negotiation.
Nested Class Summary | |
---|---|
static class |
Bytestream.Activate
The packet sent by the stream initiator to the stream proxy to activate the connection. |
static class |
Bytestream.Mode
The stream can be either a TCP stream or a UDP stream. |
static class |
Bytestream.StreamHost
Packet extension that represents a potential SOCKS5 proxy for the file transfer. |
static class |
Bytestream.StreamHostUsed
After selected a SOCKS5 stream host and successfully connecting, the target of the file transfer returns a byte stream packet with the stream host used extension. |
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ |
---|
IQ.Type |
Field Summary |
---|
Fields inherited from class org.jivesoftware.smack.packet.Packet |
---|
DEFAULT_LANGUAGE, ID_NOT_AVAILABLE |
Constructor Summary | |
---|---|
Bytestream()
The default constructor |
|
Bytestream(java.lang.String SID)
A constructor where the session ID can be specified. |
Method Summary | |
---|---|
void |
addStreamHost(Bytestream.StreamHost host)
Adds a potential stream host that the remote user can transfer the file through. |
Bytestream.StreamHost |
addStreamHost(java.lang.String JID,
java.lang.String address)
Adds a potential stream host that the remote user can connect to to receive the file. |
Bytestream.StreamHost |
addStreamHost(java.lang.String JID,
java.lang.String address,
int port)
Adds a potential stream host that the remote user can connect to to receive the file. |
int |
countStreamHosts()
Returns the count of stream hosts contained in this packet. |
java.lang.String |
getChildElementXML()
Returns the sub-element XML section of the IQ packet, or null if there isn't one. |
Bytestream.Mode |
getMode()
Returns the transport mode. |
java.lang.String |
getSessionID()
Returns the session ID related to the bytestream negotiation. |
Bytestream.StreamHost |
getStreamHost(java.lang.String JID)
Returns the stream host related to the given JID, or null if there is none. |
java.util.Collection<Bytestream.StreamHost> |
getStreamHosts()
Returns the list of stream hosts contained in the packet. |
Bytestream.Activate |
getToActivate()
Returns the activate element of the packet sent to the proxy host to verify the identity of the initiator and match them to the appropriate stream. |
Bytestream.StreamHostUsed |
getUsedHost()
Returns the SOCKS5 host connected to by the remote user. |
void |
setMode(Bytestream.Mode mode)
Set the transport mode. |
void |
setSessionID(java.lang.String sessionID)
Set the session ID related to the bytestream. |
void |
setToActivate(java.lang.String targetID)
Upon the response from the target of the used host the activate packet is sent to the SOCKS5 proxy. |
void |
setUsedHost(java.lang.String JID)
Upon connecting to the stream host the target of the stream replies to the initiator with the JID of the SOCKS5 host that they used. |
Methods inherited from class org.jivesoftware.smack.packet.IQ |
---|
createErrorResponse, createResultIQ, getType, setType, toXML |
Methods inherited from class org.jivesoftware.smack.packet.Packet |
---|
addExtension, addExtensions, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Bytestream()
public Bytestream(java.lang.String SID)
SID
- The session ID related to the negotiation.setSessionID(String)
Method Detail |
---|
public void setSessionID(java.lang.String sessionID)
sessionID
- the unique session ID that identifies the transfer.public java.lang.String getSessionID()
setSessionID(String)
public void setMode(Bytestream.Mode mode)
mode
- the transport mode, either UDP or TCPBytestream.Mode
public Bytestream.Mode getMode()
setMode(Mode)
public Bytestream.StreamHost addStreamHost(java.lang.String JID, java.lang.String address)
JID
- The JID of the stream host.address
- The internet address of the stream host.
public Bytestream.StreamHost addStreamHost(java.lang.String JID, java.lang.String address, int port)
JID
- The JID of the stream host.address
- The internet address of the stream host.port
- The port on which the remote host is seeking connections.
public void addStreamHost(Bytestream.StreamHost host)
host
- The potential stream host.public java.util.Collection<Bytestream.StreamHost> getStreamHosts()
public Bytestream.StreamHost getStreamHost(java.lang.String JID)
JID
- The JID of the desired stream host.
public int countStreamHosts()
public void setUsedHost(java.lang.String JID)
JID
- The JID of the used host.public Bytestream.StreamHostUsed getUsedHost()
public Bytestream.Activate getToActivate()
public void setToActivate(java.lang.String targetID)
targetID
- The JID of the target of the file transfer.public java.lang.String getChildElementXML()
IQ
Extensions of this class must override this method.
getChildElementXML
in class IQ
|
Smack | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |