rocks.xmpp.websocket

Class WebSocketConnection

java.lang.Object

rocks.xmpp.core.session.Connection

rocks.xmpp.websocket.WebSocketConnection

All Implemented Interfaces:

AutoCloseable

public final class WebSocketConnection
extends Connection

An XMPP WebSocket connection method.

Since:

0.7.0

See Also:

WebSocketConnectionConfiguration, XMPP Subprotocol for WebSocket

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect(rocks.xmpp.addr.Jid from, String namespace, Consumer<rocks.xmpp.addr.Jid> onStreamOpened) Connects to the server and provides an optional 'from' attribute.
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 streamElement) 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

send

public final CompletableFuture<Void> send(StreamElement streamElement)

Description copied from class: Connection

Sends an element over this connection.

Specified by:

send in class Connection

Parameters:

streamElement - The element.

Returns:

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

connect

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

Description copied from class: Connection

Connects to the server and provides an optional 'from' attribute.

Specified by:

connect in class Connection

Parameters:

from - The 'from' attribute.

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 no connection could be established, e.g. due to unknown host.

isSecure

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

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

close

public final void close()
                 throws Exception

Throws:

Exception

toString

public final String toString()

Overrides:

toString in class Object