org.apache.pekko.http.scaladsl.model.ws

Interface BinaryMessage

All Superinterfaces:

Message

All Known Implementing Classes:

BinaryMessage.Streamed, BinaryMessage.Strict

public interface BinaryMessage
extends Message

Represents a WebSocket binary message. A binary message can either be BinaryMessage.Strict in which case the complete data is already available or it can be BinaryMessage.Streamed in which case dataStream will return a Source streaming the data as it comes in.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BinaryMessage.Streamed
static class	BinaryMessage.Streamed$
static class	BinaryMessage.Strict A strict BinaryMessage that contains the complete data as a pekko.util.ByteString.
static class	BinaryMessage.Strict$

Method Summary

Modifier and Type	Method and Description
BinaryMessage	asScala()
org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,?>	dataStream() The contents of this message as a stream.
org.apache.pekko.stream.javadsl.Source<org.apache.pekko.util.ByteString,?>	getStreamedData() Java API
scala.concurrent.Future<BinaryMessage.Strict>	toStrict(scala.concurrent.duration.FiniteDuration timeout, org.apache.pekko.stream.Materializer fm) Collects all possible parts and returns a potentially future Strict Message for easier processing.
java.util.concurrent.CompletionStage<BinaryMessage.Strict>	toStrict(long timeoutMillis, org.apache.pekko.stream.Materializer materializer)

Method Detail

dataStream

org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,?> dataStream()

The contents of this message as a stream.

Returns:

(undocumented)

toStrict

scala.concurrent.Future<BinaryMessage.Strict> toStrict(scala.concurrent.duration.FiniteDuration timeout,
                                                       org.apache.pekko.stream.Materializer fm)

Collects all possible parts and returns a potentially future Strict Message for easier processing. The Future is failed with an TimeoutException if the stream isn't completed after the given timeout.

Parameters:

timeout - (undocumented)

fm - (undocumented)

Returns:

(undocumented)

getStreamedData

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

Java API

asScala

BinaryMessage asScala()

toStrict

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