Trait/Object

akka.http.scaladsl.model.ws

BinaryMessage

Related Docs: object BinaryMessage | package ws

Permalink

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. All

Abstract Value Members

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

    Permalink

    The contents of this message as a stream.

  2. abstract def getStrictData: ByteString

    Permalink

    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

    Permalink

    Is this message a strict one?

    Is this message a strict one?

    Definition Classes
    BinaryMessage

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to any2stringadd[BinaryMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (BinaryMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to ArrowAssoc[BinaryMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def asBinaryMessage: javadsl.model.ws.BinaryMessage

    Permalink

    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

    Permalink
    Definition Classes
    Any

  8. def asScala: BinaryMessage

    Permalink
    Definition Classes
    BinaryMessage → BinaryMessage → Message

  9. def asTextMessage: javadsl.model.ws.TextMessage

    Permalink

    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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def ensuring(cond: (BinaryMessage) ⇒ Boolean, msg: ⇒ Any): BinaryMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to Ensuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (BinaryMessage) ⇒ Boolean): BinaryMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to Ensuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): BinaryMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to Ensuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): BinaryMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to Ensuring[BinaryMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to StringFormat[BinaryMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. def getStreamedData: Source[ByteString, _]

    Permalink

    Java API

    Java API

    Definition Classes
    BinaryMessage → BinaryMessage

  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. def isText: Boolean

    Permalink

    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

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def →[B](y: B): (BinaryMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BinaryMessage to ArrowAssoc[BinaryMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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 from BinaryMessage to any2stringadd[BinaryMessage]

Inherited by implicit conversion StringFormat from BinaryMessage to StringFormat[BinaryMessage]

Inherited by implicit conversion Ensuring from BinaryMessage to Ensuring[BinaryMessage]

Inherited by implicit conversion ArrowAssoc from BinaryMessage to ArrowAssoc[BinaryMessage]

Ungrouped