rocks.xmpp.nio.netty.net

Class NettyChannelConnection

java.lang.Object

rocks.xmpp.core.net.AbstractConnection

rocks.xmpp.nio.netty.net.NettyChannelConnection

All Implemented Interfaces:

java.lang.AutoCloseable, Connection, TcpBinding

Direct Known Subclasses:

NettyTcpConnection

public class NettyChannelConnection
extends AbstractConnection
implements TcpBinding

A NIO connection based on Netty.

Constructor Summary

Constructors

Constructor and Description

NettyChannelConnection(io.netty.channel.Channel channel, StreamHandler streamHandler, java.util.function.BiConsumer<java.lang.String,StreamElement> onRead, java.util.function.Supplier<javax.xml.bind.Unmarshaller> unmarshallerSupplier, java.util.function.BiConsumer<java.lang.String,StreamElement> onWrite, java.util.function.Supplier<javax.xml.bind.Marshaller> marshallerSupplier, java.util.function.Consumer<java.lang.Throwable> onException, ConnectionConfiguration connectionConfiguration)

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.
java.util.concurrent.CompletionStage<java.lang.Void>	open(SessionOpen sessionOpen) Opens the XML stream to the peer entity.
void	secureConnection() Secures the connection with TLS.
java.util.concurrent.CompletionStage<java.lang.Void>	send(StreamElement streamElement) Sends an element to the peer entity.
java.lang.String	toString()
java.util.concurrent.CompletionStage<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, isUsingAcknowledgements

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, isUsingAcknowledgements

Constructor Detail

NettyChannelConnection

public NettyChannelConnection(io.netty.channel.Channel channel,
                              StreamHandler streamHandler,
                              java.util.function.BiConsumer<java.lang.String,StreamElement> onRead,
                              java.util.function.Supplier<javax.xml.bind.Unmarshaller> unmarshallerSupplier,
                              java.util.function.BiConsumer<java.lang.String,StreamElement> onWrite,
                              java.util.function.Supplier<javax.xml.bind.Marshaller> marshallerSupplier,
                              java.util.function.Consumer<java.lang.Throwable> onException,
                              ConnectionConfiguration connectionConfiguration)

Method Detail

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.

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.

send

public final java.util.concurrent.CompletionStage<java.lang.Void> send(StreamElement streamElement)

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:

streamElement - The element.

Returns:

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

write

public final java.util.concurrent.CompletionStage<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

secureConnection

public void secureConnection()
                      throws java.lang.Exception

Description copied from interface: TcpBinding

Secures the connection with TLS.

Specified by:

secureConnection in interface TcpBinding

Throws:

java.lang.Exception - Any exception which may occur during TLS handshake.

compressConnection

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

Compresses the connection.

Specified by:

compressConnection in interface TcpBinding

Parameters:

method - The compression method. Supported methods are: “zlib”, “deflate” and “gzip”.

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

Throws:

java.lang.IllegalArgumentException - If the compression method is unknown.

isSecure

public final 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.

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.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object