org.apache.pekko.http.scaladsl.unmarshalling.sse
EventStreamUnmarshalling
Companion object EventStreamUnmarshalling
trait EventStreamUnmarshalling extends AnyRef
Mixing in this trait lets a HttpEntity with a text/event-stream media type be unmarshalled to a source of
ServerSentEvents.
The maximum size for parsing server-sent events is 8KiB by default and can be customized by configuring
pekko.http.sse.max-event-size. The maximum size for parsing lines of a server-sent event is 4KiB by
default and can be customized by configuring pekko.http.sse.max-line-size.
- Annotations
- @ApiMayChange()
- Source
- EventStreamUnmarshalling.scala
- Alphabetic
- By Inheritance
- EventStreamUnmarshalling
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 EventStreamUnmarshalling toany2stringadd[EventStreamUnmarshalling] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EventStreamUnmarshalling, B)
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toArrowAssoc[EventStreamUnmarshalling] 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: (EventStreamUnmarshalling) => Boolean, msg: => Any): EventStreamUnmarshalling
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EventStreamUnmarshalling) => Boolean): EventStreamUnmarshalling
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EventStreamUnmarshalling
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EventStreamUnmarshalling
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toEnsuring[EventStreamUnmarshalling] 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])
- def fromEventsStream(settings: ServerSentEventSettings): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
Lets an
HttpEntitywith atext/event-streammedia type be unmarshalled to a source ofServerSentEvents.Lets an
HttpEntitywith atext/event-streammedia type be unmarshalled to a source ofServerSentEvents.- settings
overrides the default unmarshalling behavior.
- implicit final def fromEventsStream(implicit system: ActorSystem): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
Lets an
HttpEntitywith atext/event-streammedia type be unmarshalled to a source ofServerSentEvents. - 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()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toStringFormat[EventStreamUnmarshalling] 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.
- final val fromEventStream: FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
- Annotations
- @deprecated
- Deprecated
(Since version Akka HTTP 10.1.8) Binary compatibility method. Invocations should have an implicit ActorSystem in scope to provide access to configuration
- def maxEventSize: Int
The maximum size for parsing server-sent events; 8KiB by default.
The maximum size for parsing server-sent events; 8KiB by default.
- Attributes
- protected
- Annotations
- @deprecated
- Deprecated
(Since version Akka HTTP 10.1.8) Set this property in configuration as
pekko.http.sse.max-event-sizebefore calling fromEventsStream(implicit ActorSystem)
- def maxLineSize: Int
The maximum size for parsing lines of a server-sent event; 4KiB by default.
The maximum size for parsing lines of a server-sent event; 4KiB by default.
- Attributes
- protected
- Annotations
- @deprecated
- Deprecated
(Since version Akka HTTP 10.1.8) Set this property in configuration as
pekko.http.sse.max-line-sizebefore calling fromEventsStream(implicit ActorSystem)
- def →[B](y: B): (EventStreamUnmarshalling, B)
- Implicit
- This member is added by an implicit conversion from EventStreamUnmarshalling toArrowAssoc[EventStreamUnmarshalling] 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.