Packages

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
Linear Supertypes
Message, javadsl.model.ws.BinaryMessage, javadsl.model.ws.Message, AnyRef, Any
Known Subclasses
Streamed, Strict
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryMessage
  2. Message
  3. BinaryMessage
  4. Message
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def dataStream: Source[ByteString, _]

    The contents of this message as a stream.

  2. 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
  3. abstract def isStrict: Boolean

    Is this message a strict one?

    Is this message a strict one?

    Definition Classes
    BinaryMessage

Concrete Value Members

  1. 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
  2. def asScala: BinaryMessage
    Definition Classes
    BinaryMessage → BinaryMessage → Message
  3. 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
  4. def getStreamedData: Source[ByteString, _]

    Java API

    Java API

    Definition Classes
    BinaryMessage → BinaryMessage
  5. 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
  6. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
    Definition Classes
    BinaryMessage → BinaryMessage
  7. 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.