org.apache.pekko.http.javadsl.model.ws

Class TextMessage

java.lang.Object

org.apache.pekko.http.javadsl.model.ws.Message

org.apache.pekko.http.javadsl.model.ws.TextMessage

Direct Known Subclasses:

TextMessage.Streamed, TextMessage.Strict

public abstract class TextMessage
extends Message

Represents a WebSocket text message. A text message can either be strict in which case the complete data is already available or it can be streamed in which case getStreamedText will return a Source streaming the data as it comes in.

Constructor Summary

Constructors

Constructor and Description
TextMessage()

Method Summary

Modifier and Type	Method and Description
static TextMessage	adapt(TextMessage msg)
BinaryMessage	asBinaryMessage() Returns this BinaryMessage if it is a binary message, throws otherwise.
abstract TextMessage	asScala()
TextMessage	asTextMessage() Returns this TextMessage if it is a text message, throws otherwise.
static TextMessage	create(org.apache.pekko.stream.javadsl.Source<java.lang.String,?> textStream) Creates a streamed text message.
static TextMessage	create(java.lang.String text) Creates a strict text message.
abstract org.apache.pekko.stream.javadsl.Source<java.lang.String,?>	getStreamedText() Returns a source of the text message data.
abstract java.lang.String	getStrictText() Returns the strict message text if this message is strict, throws otherwise.
boolean	isText() Is this message a text message?
abstract java.util.concurrent.CompletionStage<TextMessage.Strict>	toStrict(long timeoutMillis, org.apache.pekko.stream.Materializer materializer)

Methods inherited from class org.apache.pekko.http.javadsl.model.ws.Message

adapt, isStrict

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextMessage

public TextMessage()

Method Detail

create

public static TextMessage create(java.lang.String text)

Creates a strict text message.

Parameters:

text - (undocumented)

Returns:

(undocumented)

create

public static TextMessage create(org.apache.pekko.stream.javadsl.Source<java.lang.String,?> textStream)

Creates a streamed text message.

Parameters:

textStream - (undocumented)

Returns:

(undocumented)

adapt

public static TextMessage adapt(TextMessage msg)

getStreamedText

public abstract org.apache.pekko.stream.javadsl.Source<java.lang.String,?> getStreamedText()

Returns a source of the text message data.

Returns:

(undocumented)

getStrictText

public abstract java.lang.String getStrictText()

Returns the strict message text if this message is strict, throws otherwise.

Returns:

(undocumented)

isText

public boolean isText()

Description copied from class: Message

Is this message a text message? If true, asTextMessage will return this text message, if false, asBinaryMessage will return this binary message.

Specified by:

isText in class Message

Returns:

(undocumented)

asTextMessage

public TextMessage asTextMessage()

Description copied from class: Message

Returns this TextMessage if it is a text message, throws otherwise.

Specified by:

asTextMessage in class Message

Returns:

(undocumented)

asBinaryMessage

public BinaryMessage asBinaryMessage()

Description copied from class: Message

Returns this BinaryMessage if it is a binary message, throws otherwise.

Specified by:

asBinaryMessage in class Message

Returns:

(undocumented)

asScala

public abstract TextMessage asScala()

Specified by:

asScala in class Message

toStrict

public abstract java.util.concurrent.CompletionStage<TextMessage.Strict> toStrict(long timeoutMillis,
                                                                                  org.apache.pekko.stream.Materializer materializer)