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
Type Hierarchy
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. Protected

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
    Message

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BinaryMessage toany2stringadd[BinaryMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BinaryMessage, B)
    Implicit
    This member is added by an implicit conversion from BinaryMessage toArrowAssoc[BinaryMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def asScala: BinaryMessage
    Definition Classes
    BinaryMessage → BinaryMessage → Message
  9. 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
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. def ensuring(cond: (BinaryMessage) => Boolean, msg: => Any): BinaryMessage
    Implicit
    This member is added by an implicit conversion from BinaryMessage toEnsuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (BinaryMessage) => Boolean): BinaryMessage
    Implicit
    This member is added by an implicit conversion from BinaryMessage toEnsuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): BinaryMessage
    Implicit
    This member is added by an implicit conversion from BinaryMessage toEnsuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): BinaryMessage
    Implicit
    This member is added by an implicit conversion from BinaryMessage toEnsuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def getStreamedData: Source[ByteString, _]

    Java API

    Java API

    Definition Classes
    BinaryMessage → BinaryMessage
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
    Definition Classes
    BinaryMessage → BinaryMessage
  27. 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.

  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BinaryMessage toStringFormat[BinaryMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (BinaryMessage, B)
    Implicit
    This member is added by an implicit conversion from BinaryMessage toArrowAssoc[BinaryMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Message

Inherited from javadsl.model.ws.BinaryMessage

Inherited from javadsl.model.ws.Message

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBinaryMessage to any2stringadd[BinaryMessage]

Inherited by implicit conversion StringFormat fromBinaryMessage to StringFormat[BinaryMessage]

Inherited by implicit conversion Ensuring fromBinaryMessage to Ensuring[BinaryMessage]

Inherited by implicit conversion ArrowAssoc fromBinaryMessage to ArrowAssoc[BinaryMessage]

Ungrouped