Packages

sealed trait TextMessage extends javadsl.model.ws.TextMessage with Message

Represents a WebSocket text message. A text message can either be a TextMessage.Strict in which case the complete data is already available or it can be TextMessage.Streamed in which case textStream will return a Source streaming the data as it comes in.

Source
Message.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextMessage
  2. Message
  3. TextMessage
  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 getStrictText: String

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

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

    Definition Classes
    TextMessage
  2. abstract def isStrict: Boolean

    Is this message a strict one?

    Is this message a strict one?

    Definition Classes
    Message
  3. abstract def textStream: Source[String, _]

    The contents of this message as a stream.

Concrete Value Members

  1. 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
    TextMessageMessage
  2. def asScala: TextMessage
    Definition Classes
    TextMessageTextMessageMessage
  3. 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
    TextMessageMessage
  4. def getStreamedText: Source[String, _]

    Java API

    Java API

    Definition Classes
    TextMessageTextMessage
  5. 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
    TextMessageMessage
  6. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]
    Definition Classes
    TextMessageTextMessage
  7. 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.