sealed trait BinaryMessage extends javadsl.model.ws.BinaryMessage with 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.
- Source
- Message.scala
- Alphabetic
- By Inheritance
- BinaryMessage
- Message
- BinaryMessage
- Message
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
dataStream: Source[ByteString, _]
The contents of this message as a stream.
-
abstract
def
getStrictData: ByteString
Returns the strict message data if this message is strict, throws otherwise.
Returns the strict message data if this message is strict, throws otherwise.
- Definition Classes
- BinaryMessage
-
abstract
def
isStrict: Boolean
Is this message a strict one?
Is this message a strict one?
- Definition Classes
- BinaryMessage
Concrete Value Members
-
def
asBinaryMessage: javadsl.model.ws.BinaryMessage
Returns this BinaryMessage if it is a binary message, throws otherwise.
Returns this BinaryMessage if it is a binary message, throws otherwise.
- Definition Classes
- BinaryMessage → Message
-
def
asScala: BinaryMessage
- Definition Classes
- BinaryMessage → BinaryMessage → Message
-
def
asTextMessage: javadsl.model.ws.TextMessage
Returns this TextMessage if it is a text message, throws otherwise.
Returns this TextMessage if it is a text message, throws otherwise.
- Definition Classes
- BinaryMessage → Message
-
def
getStreamedData: Source[ByteString, _]
Java API
Java API
- Definition Classes
- BinaryMessage → BinaryMessage
-
def
isText: Boolean
Is this message a text message? If true, asTextMessage will return this text message, if false, asBinaryMessage will return this binary message.
Is this message a text message? If true, asTextMessage will return this text message, if false, asBinaryMessage will return this binary message.
- Definition Classes
- BinaryMessage → Message
-
def
toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
- Definition Classes
- BinaryMessage → BinaryMessage
-
def
toStrict(timeout: FiniteDuration)(implicit fm: Materializer): Future[Strict]
Collects all possible parts and returns a potentially future Strict Message for easier processing.
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.