rocks.xmpp.core.session

Class TcpConnection

java.lang.Object

rocks.xmpp.core.session.Connection

rocks.xmpp.core.session.TcpConnection

All Implemented Interfaces:

AutoCloseable

public final class TcpConnection
extends Connection

The default TCP socket connection as described in TCP Binding.

If no hostname is set (null or empty) the connection tries to resolve the hostname via an SRV DNS lookup.

This class is unconditionally thread-safe.

See Also:

3. TCP Binding

Method Summary

Modifier and Type	Method and Description
void	close() Closes the TCP connection.
void	connect(rocks.xmpp.addr.Jid from, String namespace, Consumer<rocks.xmpp.addr.Jid> onStreamOpened) Connects to the specified XMPP server using a socket connection.
String	getStreamId() Gets the stream id of this connection.
boolean	isSecure() Indicates whether this connection is secured by TLS/SSL.
boolean	isUsingAcknowledgements() Indicates, whether this connection is using acknowledgements.
CompletableFuture<Void>	send(StreamElement element) Sends an element over this connection.
String	toString()

Methods inherited from class rocks.xmpp.core.session.Connection

getConfiguration, getHostname, getPort, getProxy

Methods inherited from class java.lang.Object

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

Method Detail

connect

public final void connect(rocks.xmpp.addr.Jid from,
                          String namespace,
                          Consumer<rocks.xmpp.addr.Jid> onStreamOpened)
                   throws IOException

Connects to the specified XMPP server using a socket connection. Stream features are negotiated until SASL negotiation, which will be negotiated separately in the XmppClient.login(String, String) method.

If only a XMPP service domain has been specified, it is tried to resolve the FQDN via SRV lookup.
If that fails, it is tried to connect directly the XMPP service domain on port 5222.
If a hostname and port have been specified, these are used to establish the connection.
If a proxy has been specified, the connection is established through this proxy.

Specified by:

connect in class Connection

Parameters:

from - The optional 'from' attribute in the stream header.

namespace - The content namespace, e.g. "jabber:client".

onStreamOpened - The callback which gets notified when the stream gets opened, i.e. when the server has responded with a stream header. The parameter of the consumer is the stream id.

Throws:

IOException - If the underlying socket throws an exception.

isSecure

public boolean isSecure()

Description copied from class: Connection

Indicates whether this connection is secured by TLS/SSL.

Specified by:

isSecure in class Connection

Returns:

True, if this connection is secured.

send

public final CompletableFuture<Void> send(StreamElement element)

Description copied from class: Connection

Sends an element over this connection.

Specified by:

send in class Connection

Parameters:

element - The element.

Returns:

The future representing the send process and which allows to cancel it.

close

public final void close()
                 throws Exception

Closes the TCP connection. It first sends a </stream:stream>, then shuts down the writer so that no more stanzas can be sent. After that it shuts down the reader and awaits shortly for any stanzas from the server and the server gracefully closing the stream with </stream:stream>. Eventually the socket is closed.

Throws:

IOException - If the socket throws an I/O exception.

Exception

getStreamId

public final String getStreamId()

Description copied from class: Connection

Gets the stream id of this connection.

Specified by:

getStreamId in class Connection

Returns:

The stream id.

isUsingAcknowledgements

public final boolean isUsingAcknowledgements()

Description copied from class: Connection

Indicates, whether this connection is using acknowledgements.

TCP and WebSocket connections use XEP-0198: Stream Management to acknowledge stanzas.

BOSH connections use another mechanism for acknowledgements, described in XEP-0124 § 9. Acknowledgements.

Specified by:

isUsingAcknowledgements in class Connection

Returns:

True, if this connection is using acknowledgements.

See Also:

XEP-0198: Stream Management, XEP-0124 § 9. Acknowledgements

toString

public final String toString()

Overrides:

toString in class Object