abstract class ServerSentEventSettings extends AnyRef

Public API but not intended for subclassing

Options that are in "preview" or "early access" mode. These options may change and/or be removed within patch releases without early notice (e.g. by moving them into a stable supported place).

Self Type
ServerSentEventSettingsImpl
Annotations
@ApiMayChange() @DoNotInherit()
Source
ServerSentEventSettings.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ServerSentEventSettings
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerSentEventSettings
  2. AnyRef
  3. 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 emitEmptyEvents: Boolean

    Should events with empty data field be passed to the application.

  2. abstract def maxEventSize: Int

    The maximum size for parsing server-sent events

  3. abstract def maxLineSize: Int

    The maximum size for parsing lines of a server-sent event

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 ServerSentEventSettings toany2stringadd[ServerSentEventSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ServerSentEventSettings, B)
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toArrowAssoc[ServerSentEventSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def ensuring(cond: (ServerSentEventSettings) => Boolean, msg: => Any): ServerSentEventSettings
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toEnsuring[ServerSentEventSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ServerSentEventSettings) => Boolean): ServerSentEventSettings
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toEnsuring[ServerSentEventSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ServerSentEventSettings
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toEnsuring[ServerSentEventSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ServerSentEventSettings
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toEnsuring[ServerSentEventSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def getOversizedEventStrategy: String

    How to handle events that exceed max-event-size limit.

    How to handle events that exceed max-event-size limit. Valid options: "fail-stream", "log-and-skip", "truncate", "dead-letter"

    Since

    1.3.0

  16. def getOversizedEventStrategyEnum: OversizedSseStrategy

    How to handle events that exceed max-event-size limit.

    How to handle events that exceed max-event-size limit. Returns the strategy as a Java enum.

    Since

    1.3.0

  17. def getOversizedLineStrategy: String

    How to handle lines that exceed max-line-size limit.

    How to handle lines that exceed max-line-size limit. Valid options: "fail-stream", "log-and-skip", "truncate", "dead-letter"

    Since

    1.3.0

  18. def getOversizedLineStrategyEnum: OversizedSseStrategy

    How to handle lines that exceed max-line-size limit.

    How to handle lines that exceed max-line-size limit. Returns the strategy as a Java enum.

    Since

    1.3.0

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def withEmitEmptyEvents(newValue: Boolean): ServerSentEventSettings
  30. def withLineLength(newValue: Int): ServerSentEventSettings
  31. def withMaxEventSize(newValue: Int): ServerSentEventSettings
  32. def withOversizedEventStrategy(newValue: OversizedSseStrategy): ServerSentEventSettings

    Since

    1.3.0

  33. def withOversizedEventStrategy(newValue: String): ServerSentEventSettings

    Since

    1.3.0

  34. def withOversizedLineStrategy(newValue: OversizedSseStrategy): ServerSentEventSettings

    Since

    1.3.0

  35. def withOversizedLineStrategy(newValue: String): ServerSentEventSettings

    Since

    1.3.0

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 ServerSentEventSettings toStringFormat[ServerSentEventSettings] 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): (ServerSentEventSettings, B)
    Implicit
    This member is added by an implicit conversion from ServerSentEventSettings toArrowAssoc[ServerSentEventSettings] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromServerSentEventSettings to any2stringadd[ServerSentEventSettings]

Inherited by implicit conversion StringFormat fromServerSentEventSettings to StringFormat[ServerSentEventSettings]

Inherited by implicit conversion Ensuring fromServerSentEventSettings to Ensuring[ServerSentEventSettings]

Inherited by implicit conversion ArrowAssoc fromServerSentEventSettings to ArrowAssoc[ServerSentEventSettings]

Ungrouped