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
Known Subclasses
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- TextMessage
- Message
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new TextMessage()
Abstract Value Members
- abstract def asScala: scaladsl.model.ws.TextMessage
- Definition Classes
- TextMessage → Message
- abstract def getStreamedText: Source[String, _]
Returns a source of the text message data.
- abstract def getStrictText: String
Returns the strict message text if this message is strict, throws otherwise.
- abstract def isStrict: Boolean
Is this message a strict one?
Is this message a strict one?
- Definition Classes
- Message
- abstract def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Inherited from Any
Inherited by implicit conversion any2stringadd fromTextMessage to any2stringadd[TextMessage]
Value Members
- 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
Inherited by implicit conversion StringFormat fromTextMessage to StringFormat[TextMessage]
Value Members
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
Inherited by implicit conversion Ensuring fromTextMessage to Ensuring[TextMessage]
Value Members
- 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
- 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
- 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
- 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
Inherited by implicit conversion ArrowAssoc fromTextMessage to ArrowAssoc[TextMessage]
Value Members
- 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()
- 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.
Ungrouped
- abstract def asScala: scaladsl.model.ws.TextMessage
- Definition Classes
- TextMessage → Message
- abstract def getStreamedText: Source[String, _]
Returns a source of the text message data.
- abstract def getStrictText: String
Returns the strict message text if this message is strict, throws otherwise.
- abstract def isStrict: Boolean
Is this message a strict one?
Is this message a strict one?
- Definition Classes
- Message
- abstract def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.