Packages

abstract class TextMessage extends Message

Represents a WebSocket text message. A text message can either be strict in which case the complete data is already available or it can be streamed in which case getStreamedText will return a Source streaming the data as it comes in.

Source
Message.scala
Linear Supertypes
Message, AnyRef, Any
Known Subclasses
TextMessage, Streamed, Strict
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextMessage
  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 TextMessage()

Abstract Value Members

  1. abstract def asScala: scaladsl.model.ws.TextMessage
    Definition Classes
    TextMessage → Message
  2. abstract def getStreamedText: Source[String, _]

    Returns a source of the text message data.

  3. abstract def getStrictText: String

    Returns the strict message text 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. 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 TextMessage toany2stringadd[TextMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TextMessage, B)
    Implicit
    This member is added by an implicit conversion from TextMessage toArrowAssoc[TextMessage] 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: 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
    TextMessage → Message
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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
    TextMessage → Message
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def ensuring(cond: (TextMessage) => Boolean, msg: => Any): TextMessage
    Implicit
    This member is added by an implicit conversion from TextMessage toEnsuring[TextMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (TextMessage) => Boolean): TextMessage
    Implicit
    This member is added by an implicit conversion from TextMessage toEnsuring[TextMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): TextMessage
    Implicit
    This member is added by an implicit conversion from TextMessage toEnsuring[TextMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): TextMessage
    Implicit
    This member is added by an implicit conversion from TextMessage toEnsuring[TextMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
    TextMessage → Message
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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 TextMessage toStringFormat[TextMessage] 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): (TextMessage, B)
    Implicit
    This member is added by an implicit conversion from TextMessage toArrowAssoc[TextMessage] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTextMessage to any2stringadd[TextMessage]

Inherited by implicit conversion StringFormat fromTextMessage to StringFormat[TextMessage]

Inherited by implicit conversion Ensuring fromTextMessage to Ensuring[TextMessage]

Inherited by implicit conversion ArrowAssoc fromTextMessage to ArrowAssoc[TextMessage]

Ungrouped