org.apache.pekko.http.scaladsl.unmarshalling.sse
EventStreamUnmarshalling
Companion trait EventStreamUnmarshalling
object EventStreamUnmarshalling extends EventStreamUnmarshalling
Importing EventStreamUnmarshalling.fromEventsStream lets an 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. The maximum size for parsing lines of a server-sent event
is 4KiB. If you need to customize any of these, set the pekko.http.sse.max-event-size
and
pekko.http.sse.max-line-size
properties respectively.
- Annotations
- @ApiMayChange()
- Source
- EventStreamUnmarshalling.scala
- Alphabetic
- By Inheritance
- EventStreamUnmarshalling
- EventStreamUnmarshalling
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- 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])
- def fromEventsStream(settings: ServerSentEventSettings): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
Lets an
HttpEntity
with atext/event-stream
media type be unmarshalled to a source ofServerSentEvent
s.Lets an
HttpEntity
with atext/event-stream
media type be unmarshalled to a source ofServerSentEvent
s.- settings
overrides the default unmarshalling behavior.
- Definition Classes
- EventStreamUnmarshalling
- implicit final def fromEventsStream(implicit system: ActorSystem): FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
Lets an
HttpEntity
with atext/event-stream
media type be unmarshalled to a source ofServerSentEvent
s.Lets an
HttpEntity
with atext/event-stream
media type be unmarshalled to a source ofServerSentEvent
s.- Definition Classes
- EventStreamUnmarshalling
- 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
- final val fromEventStream: FromEntityUnmarshaller[Source[ServerSentEvent, NotUsed]]
- Definition Classes
- EventStreamUnmarshalling
- 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
- Definition Classes
- EventStreamUnmarshalling
- Annotations
- @deprecated
- Deprecated
(Since version Akka HTTP 10.1.8) Set this property in configuration as
pekko.http.sse.max-event-size
before 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
- Definition Classes
- EventStreamUnmarshalling
- Annotations
- @deprecated
- Deprecated
(Since version Akka HTTP 10.1.8) Set this property in configuration as
pekko.http.sse.max-line-size
before calling fromEventsStream(implicit ActorSystem)