ServerSentEvent

zio.http.ServerSentEvent

See theServerSentEvent companion object

A Server-Sent Event (SSE) envelope carrying typed data.

The payload A is rendered into one or more data: lines via an SseDataEncoder. The remaining fields (event, id, retry) are SSE metadata owned by the envelope itself.

Attributes

Companion: object
Source: ServerSentEvent.scala
Graph
Supertypes: class Object

trait Matchable

class Any

Members list

Value members

Concrete methods

Removes the event field.

Attributes

Source: ServerSentEvent.scala

Removes the retry field.

Attributes

Source: ServerSentEvent.scala

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that: the object to compare against this object for equality.

Attributes

Returns: true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes: Any
Source: ServerSentEvent.scala

Sets the event field.

Attributes

Source: ServerSentEvent.scala

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.