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

Class BinaryMessage

java.lang.Object

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

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

Direct Known Subclasses:

BinaryMessage.Streamed, BinaryMessage.Strict

public abstract class BinaryMessage
extends Message

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

Constructor Summary

Constructors

Constructor and Description
BinaryMessage()

Method Summary

Modifier and Type	Method and Description
static BinaryMessage	adapt(BinaryMessage msg)
BinaryMessage	asBinaryMessage() Returns this BinaryMessage if it is a binary message, throws otherwise.
abstract BinaryMessage	asScala()
TextMessage	asTextMessage() Returns this TextMessage if it is a text message, throws otherwise.
static BinaryMessage	create(org.apache.pekko.util.ByteString data) Creates a strict binary message.
static BinaryMessage	create(org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,?> dataStream) Creates a streamed binary message.
abstract org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,?>	getStreamedData() Returns a source of the binary message data.
abstract org.apache.pekko.util.ByteString	getStrictData() Returns the strict message data if this message is strict, throws otherwise.
boolean	isText() Is this message a text message?
abstract java.util.concurrent.CompletionStage<BinaryMessage.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

BinaryMessage

public BinaryMessage()

Method Detail

create

public static BinaryMessage create(org.apache.pekko.util.ByteString data)

Creates a strict binary message.

Parameters:

data - (undocumented)

Returns:

(undocumented)

create

public static BinaryMessage create(org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,?> dataStream)

Creates a streamed binary message.

Parameters:

dataStream - (undocumented)

Returns:

(undocumented)

adapt

public static BinaryMessage adapt(BinaryMessage msg)

getStreamedData

public abstract org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,?> getStreamedData()

Returns a source of the binary message data.

Returns:

(undocumented)

getStrictData

public abstract org.apache.pekko.util.ByteString getStrictData()

Returns the strict message data 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 BinaryMessage asScala()

Specified by:

asScala in class Message

toStrict

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