Package com.yahoo.search.result

Class EventStream

java.lang.Object

com.yahoo.component.provider.FreezableClass

com.yahoo.component.provider.ListenableFreezableClass

com.yahoo.search.result.Hit

com.yahoo.search.result.EventStream

All Implemented Interfaces:

com.yahoo.component.provider.Freezable, com.yahoo.component.provider.ListenableFreezable, com.yahoo.processing.response.Data, com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>, Cloneable, Comparable<Hit>

public class EventStream
extends Hit
implements com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

A stream of events which can be rendered as Server-Sent Events (SSE).

Author:

lesters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventStream.ErrorEvent
static class	EventStream.Event

Nested classes/interfaces inherited from class com.yahoo.search.result.Hit

Hit.RawUtf8Consumer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EVENT_TYPE
static final String	EVENT_TYPE_TOKEN

Fields inherited from class com.yahoo.search.result.Hit

RANKFEATURES_FIELD, SDDOCNAME_FIELD

Constructor Summary

Constructors

Constructor	Description
EventStream()

Method Summary

Modifier and Type	Method	Description
com.yahoo.processing.response.Data	add(com.yahoo.processing.response.Data event)
void	add(String data)
void	add(String data, String type)
void	addDataListener(Runnable runnable)
List<com.yahoo.processing.response.Data>	asList()
void	close()	Releases the resources held by this, making it irreversibly unusable
CompletableFuture<com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>>	completeFuture()
void	error(String source, ErrorMessage message)
com.yahoo.processing.response.Data	get(int index)
com.yahoo.processing.response.IncomingData<com.yahoo.processing.response.Data>	incoming()
void	markComplete()

Methods inherited from class com.yahoo.search.result.Hit

assignId, buildHitField, clearFields, clone, compareTo, equals, features, fieldIterator, fieldKeys, fields, forEachField, forEachFieldAsRaw, getDisplayId, getField, getFilled, getId, getQuery, getRelevance, getSearcherSpecificMetaData, getSource, hasField, hasFields, hashCode, isAuxiliary, isCached, isFillable, isFilled, isMeta, removeField, request, reserve, setAuxiliary, setCached, setField, setFillable, setFilled, setId, setId, setMeta, setQuery, setRelevance, setRelevance, setSearcherSpecificMetaData, setSource, toString, types

Methods inherited from class com.yahoo.component.provider.ListenableFreezableClass

addFreezeListener, freeze

Methods inherited from class com.yahoo.component.provider.FreezableClass

ensureNotFrozen, isFrozen

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.processing.response.Data

request

Methods inherited from interface com.yahoo.component.provider.Freezable

freeze, isFrozen

Methods inherited from interface com.yahoo.component.provider.ListenableFreezable

addFreezeListener

Field Details

EVENT_TYPE_TOKEN

public static final String EVENT_TYPE_TOKEN

See Also:

• Constant Field Values

DEFAULT_EVENT_TYPE

public static final String DEFAULT_EVENT_TYPE

See Also:

• Constant Field Values

Constructor Details

EventStream

public EventStream()

Method Details

add

public void add(String data)

add

public void add(String data,
 String type)

error

public void error(String source,
 ErrorMessage message)

markComplete

public void markComplete()

add

public com.yahoo.processing.response.Data add(com.yahoo.processing.response.Data event)

Specified by:

add in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

get

public com.yahoo.processing.response.Data get(int index)

Specified by:

get in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

asList

public List<com.yahoo.processing.response.Data> asList()

Specified by:

asList in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

incoming

public com.yahoo.processing.response.IncomingData<com.yahoo.processing.response.Data> incoming()

Specified by:

incoming in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

completeFuture

public CompletableFuture<com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>> completeFuture()

Specified by:

completeFuture in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

addDataListener

public void addDataListener(Runnable runnable)

Specified by:

addDataListener in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

close

public void close()

Description copied from class: Hit

Releases the resources held by this, making it irreversibly unusable

Specified by:

close in interface com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data>

Overrides:

close in class Hit