org.apache.pekko.http.scaladsl.settings
ServerSentEventSettings
Companion object ServerSentEventSettings
abstract class ServerSentEventSettings extends javadsl.settings.ServerSentEventSettings
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
- Alphabetic
- By Inheritance
- ServerSentEventSettings
- ServerSentEventSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def emitEmptyEvents: Boolean
Should events with empty data field be passed to the application.
Should events with empty data field be passed to the application.
- Definition Classes
- ServerSentEventSettings
- abstract def maxEventSize: Int
The maximum size for parsing server-sent events
The maximum size for parsing server-sent events
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- abstract def maxLineSize: Int
The maximum size for parsing lines of a server-sent event
The maximum size for parsing lines of a server-sent event
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
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 ServerSentEventSettings toany2stringadd[ServerSentEventSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- 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
- 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 withEmitEmptyEvents(newValue: Boolean): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- def withLineLength(newValue: Int): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- def withMaxEventSize(newValue: Int): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
Deprecated Value Members
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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 javadsl.settings.ServerSentEventSettings
Value Members
- abstract def emitEmptyEvents: Boolean
Should events with empty data field be passed to the application.
Should events with empty data field be passed to the application.
- Definition Classes
- ServerSentEventSettings
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 fromServerSentEventSettings to any2stringadd[ServerSentEventSettings]
Value Members
- 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
Inherited by implicit conversion StringFormat fromServerSentEventSettings to StringFormat[ServerSentEventSettings]
Value Members
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
Inherited by implicit conversion Ensuring fromServerSentEventSettings to Ensuring[ServerSentEventSettings]
Value Members
- 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
- 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
- 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
- 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
Inherited by implicit conversion ArrowAssoc fromServerSentEventSettings to ArrowAssoc[ServerSentEventSettings]
Value Members
- 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()
- 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.
Ungrouped
- abstract def emitEmptyEvents: Boolean
Should events with empty data field be passed to the application.
Should events with empty data field be passed to the application.
- Definition Classes
- ServerSentEventSettings
- abstract def maxEventSize: Int
The maximum size for parsing server-sent events
The maximum size for parsing server-sent events
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- abstract def maxLineSize: Int
The maximum size for parsing lines of a server-sent event
The maximum size for parsing lines of a server-sent event
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- 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 ServerSentEventSettings toany2stringadd[ServerSentEventSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- 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
- 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
- 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 withEmitEmptyEvents(newValue: Boolean): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- def withLineLength(newValue: Int): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- def withMaxEventSize(newValue: Int): ServerSentEventSettings
- Definition Classes
- ServerSentEventSettings → ServerSentEventSettings
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.