rocks.xmpp.websocket.net

Class WebSocketConnection

java.lang.Object

rocks.xmpp.core.net.AbstractConnection

rocks.xmpp.websocket.net.WebSocketConnection

All Implemented Interfaces:

java.lang.AutoCloseable, Connection

Direct Known Subclasses:

WebSocketClientConnection

public class WebSocketConnection
extends AbstractConnection

An XMPP WebSocket connection.

Since:

0.7.0

See Also:

XMPP Subprotocol for WebSocket

Constructor Summary

Constructors

Constructor and Description
WebSocketConnection(javax.websocket.Session session, StreamHandler streamHandler, java.util.function.Consumer<java.lang.Throwable> onException, java.util.concurrent.CompletableFuture<java.lang.Void> closeFuture, 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	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.
java.util.concurrent.CompletableFuture<java.lang.Void>	send(StreamElement streamElement) 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, isUsingAcknowledgements

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketConnection

public WebSocketConnection(javax.websocket.Session session,
                           StreamHandler streamHandler,
                           java.util.function.Consumer<java.lang.Throwable> onException,
                           java.util.concurrent.CompletableFuture<java.lang.Void> closeFuture,
                           ConnectionConfiguration connectionConfiguration)

Method Detail

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.

Returns:

The close future.

send

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

Parameters:

streamElement - 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.

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.

getRemoteAddress

public final java.net.InetSocketAddress getRemoteAddress()

Description copied from interface: Connection

Gets the remote address of this 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.

Parameters:

sessionOpen - The session open information.

isSecure

public final boolean isSecure()

Description copied from interface: Connection

Indicates whether this connection is secured by TLS/SSL.

Returns:

True, if this connection is secured.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object