Packages

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.

Source
Message.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryMessage
  2. Message
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BinaryMessage()

Abstract Value Members

  1. abstract def asScala: scaladsl.model.ws.BinaryMessage
    Definition Classes
    BinaryMessageMessage
  2. abstract def getStreamedData: Source[ByteString, _]

    Returns a source of the binary message data.

  3. abstract def getStrictData: ByteString

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

  4. abstract def isStrict: Boolean

    Is this message a strict one?

    Is this message a strict one?

    Definition Classes
    Message
  5. abstract def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]

Concrete Value Members

  1. def asBinaryMessage: 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
    BinaryMessageMessage
  2. def asTextMessage: 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
    BinaryMessageMessage
  3. 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
    BinaryMessageMessage