rocks.xmpp.core.net.client

Class SocketConnection

java.lang.Object

rocks.xmpp.core.net.AbstractConnection

rocks.xmpp.core.net.client.SocketConnection

All Implemented Interfaces:

java.lang.AutoCloseable, Connection, TcpBinding

public final class SocketConnection
extends AbstractConnection
implements TcpBinding

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

Constructor Summary

Constructors

Constructor and Description
SocketConnection(java.net.Socket socket, XmppSession xmppSession, TcpConnectionConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<java.lang.Void>	closeFuture() Returns a future which is complete, when the connection is closed.
void	compressConnection(java.lang.String method, java.lang.Runnable onSuccess) Compresses the connection.
void	flush() Flushes the connection.
java.net.InetSocketAddress	getRemoteAddress() Gets the remote address of this connection.
boolean	isSecure() Indicates whether this connection is secured by TLS/SSL.
boolean	isUsingAcknowledgements() Indicates whether this connection uses acknowledgements, e.g. by means of stream management or BOSH acks.
java.util.concurrent.CompletionStage<java.lang.Void>	open(SessionOpen sessionOpen) Opens the XML stream to the peer entity.
void	secureConnection() This method is called from the reader thread.
java.util.concurrent.CompletableFuture<java.lang.Void>	send(StreamElement element) Sends an element to the peer entity.
java.lang.String	toString()
java.util.concurrent.CompletableFuture<java.lang.Void>	write(StreamElement streamElement) Writes the element to the stream without really sending it.

Methods inherited from class rocks.xmpp.core.net.AbstractConnection

close, closeAsync, closeAsync, getConfiguration, getStreamId

Methods inherited from class java.lang.Object

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

Methods inherited from interface rocks.xmpp.core.net.Connection

close, closeAsync, closeAsync, getConfiguration, getStreamId

Constructor Detail

SocketConnection

public SocketConnection(java.net.Socket socket,
                        XmppSession xmppSession,
                        TcpConnectionConfiguration configuration)

Method Detail

open

public final java.util.concurrent.CompletionStage<java.lang.Void> open(SessionOpen sessionOpen)

Description copied from interface: Connection

Opens the XML stream to the peer entity.

Specified by:

open in interface Connection

Parameters:

sessionOpen - The session open information.

isSecure

public boolean isSecure()

Description copied from interface: Connection

Indicates whether this connection is secured by TLS/SSL.

Specified by:

isSecure in interface Connection

Returns:

True, if this connection is secured.

secureConnection

public void secureConnection()
                      throws java.io.IOException,
                             java.security.cert.CertificateException,
                             java.security.NoSuchAlgorithmException

This method is called from the reader thread. Because it accesses shared data (socket, outputStream, inputStream) it should be synchronized.

Specified by:

secureConnection in interface TcpBinding

Throws:

java.io.IOException

java.security.cert.CertificateException

java.security.NoSuchAlgorithmException

compressConnection

public void compressConnection(java.lang.String method,
                               java.lang.Runnable onSuccess)
                        throws java.lang.Exception

Description copied from interface: TcpBinding

Compresses the connection.

Specified by:

compressConnection in interface TcpBinding

Parameters:

method - The compression method.

onSuccess - Invoked after the compression method has been chosen, but before compression is applied.

Throws:

java.lang.Exception

send

public final java.util.concurrent.CompletableFuture<java.lang.Void> send(StreamElement element)

Description copied from interface: Connection

Sends an element to the peer entity. This is basically a short cut for write + flush.

Specified by:

send in interface Connection

Parameters:

element - The element.

Returns:

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

write

public final java.util.concurrent.CompletableFuture<java.lang.Void> write(StreamElement streamElement)

Description copied from interface: Connection

Writes the element to the stream without really sending it. It must be flushed.

Specified by:

write in interface Connection

Parameters:

streamElement - The element.

Returns:

The send future.

flush

public final void flush()

Description copied from interface: Connection

Flushes the connection. Any buffered elements written via Connection.write(StreamElement) are sent.

Specified by:

flush in interface Connection

closeFuture

public final java.util.concurrent.CompletionStage<java.lang.Void> closeFuture()

Description copied from interface: Connection

Returns a future which is complete, when the connection is closed.

Specified by:

closeFuture in interface Connection

Returns:

The close future.

getRemoteAddress

public final java.net.InetSocketAddress getRemoteAddress()

Description copied from interface: Connection

Gets the remote address of this connection.

Specified by:

getRemoteAddress in interface Connection

Returns:

The remote address.

isUsingAcknowledgements

public final boolean isUsingAcknowledgements()

Description copied from interface: Connection

Indicates whether this connection uses acknowledgements, e.g. by means of stream management or BOSH acks.

Specified by:

isUsingAcknowledgements in interface Connection

Overrides:

isUsingAcknowledgements in class AbstractConnection

Returns:

If this connection uses acknowledgements.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object