akasha

Class EventSource

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.EventSource

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="EventSource")
public class EventSource
extends EventTarget

The EventSource interface is web content's interface to server-sent events. An EventSource instance opens a persistent connection to an HTTP server, which sends events in text/event-stream format.

See Also:

EventSource - MDN, (HTML) # the-eventsource-interface

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSED
static int	CONNECTING
EventHandler	onerror The onerror property of the EventSource interface is an EventHandler called when an error occurs and the error event is dispatched on an EventSource object.
MessageEventHandler	onmessage The onmessage property of the EventSource interface is an EventHandler called when a message event is received, that is when a message is coming from the source.
EventHandler	onopen The onopen property of the EventSource interface is an EventHandler called when an open event is received, that is when the connection was just opened.
static int	OPEN

Constructor Summary

Constructors

Constructor and Description
EventSource(java.lang.String url) The EventSource() constructor returns a newly-created EventSource, which represents a remote resource.
EventSource(java.lang.String url, EventSourceInit eventSourceInitDict) The EventSource() constructor returns a newly-created EventSource, which represents a remote resource.

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
void	addOpenListener(EventListener callback)
void	addOpenListener(EventListener callback, AddEventListenerOptions options)
void	addOpenListener(EventListener callback, boolean useCapture)
void	close() The close() method of the EventSource interface closes the connection, if one is made, and sets the EventSource.readyState attribute to 2 (closed).
int	readyState() The readyState read-only property of the EventSource interface returns a number representing the state of the connection.
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)
void	removeOpenListener(EventListener callback)
void	removeOpenListener(EventListener callback, boolean useCapture)
void	removeOpenListener(EventListener callback, EventListenerOptions options)
java.lang.String	url() The url read-only property of the EventSource interface returns a DOMString representing the URL of the source.
boolean	withCredentials() The withCredentials read-only property of the EventSource interface returns a Boolean indicating whether the EventSource object was instantiated with CORS credentials set.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLOSED

@JsOverlay
public static final int CLOSED

See Also:

Constant Field Values

CONNECTING

@JsOverlay
public static final int CONNECTING

See Also:

Constant Field Values

OPEN

@JsOverlay
public static final int OPEN

See Also:

Constant Field Values

onerror

@Nullable
public EventHandler onerror

The onerror property of the EventSource interface is an EventHandler called when an error occurs and the error event is dispatched on an EventSource object.

See Also:

EventSource.onerror - MDN, onerror - HTML Living Standard

onmessage

@Nullable
public MessageEventHandler onmessage

The onmessage property of the EventSource interface is an EventHandler called when a message event is received, that is when a message is coming from the source.

See Also:

EventSource.onmessage - MDN, onmessage - HTML Living Standard

onopen

@Nullable
public EventHandler onopen

The onopen property of the EventSource interface is an EventHandler called when an open event is received, that is when the connection was just opened.

See Also:

EventSource.onopen - MDN, onopen - HTML Living Standard

Constructor Detail

EventSource

public EventSource(@Nonnull
                   java.lang.String url,
                   @Nonnull
                   EventSourceInit eventSourceInitDict)

The EventSource() constructor returns a newly-created EventSource, which represents a remote resource.

See Also:

EventSource.EventSource - MDN, EventSource() - HTML Living Standard

EventSource

public EventSource(@Nonnull
                   java.lang.String url)

The EventSource() constructor returns a newly-created EventSource, which represents a remote resource.

See Also:

EventSource.EventSource - MDN, EventSource() - HTML Living Standard

Method Detail

readyState

@JsProperty(name="readyState")
 @EventSourceReadyState
public int readyState()

The readyState read-only property of the EventSource interface returns a number representing the state of the connection.

See Also:

EventSource.readyState - MDN, readyState - HTML Living Standard

url

@JsProperty(name="url")
 @Nonnull
public java.lang.String url()

The url read-only property of the EventSource interface returns a DOMString representing the URL of the source.

See Also:

EventSource.url - MDN, url - HTML Living Standard

withCredentials

@JsProperty(name="withCredentials")
public boolean withCredentials()

The withCredentials read-only property of the EventSource interface returns a Boolean indicating whether the EventSource object was instantiated with CORS credentials set.

See Also:

EventSource.withCredentials - MDN, withCredentials - HTML Living Standard

close

public void close()

The close() method of the EventSource interface closes the connection, if one is made, and sets the EventSource.readyState attribute to 2 (closed).

See Also:

EventSource.close - MDN, close() - HTML Living Standard

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                boolean useCapture)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   boolean useCapture)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback,
                                             boolean useCapture)

addOpenListener

@JsOverlay
public final void addOpenListener(@Nonnull
                                             EventListener callback)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback,
                                                boolean useCapture)

removeOpenListener

@JsOverlay
public final void removeOpenListener(@Nonnull
                                                EventListener callback)