W3cubDocs

/Haxe JavaScript

EventSource

package js.html

extends EventTarget

@:native("EventSource") Available on js

The EventSource interface is used to receive server-sent events. It connects to a server over HTTP and receives events in text/event-stream format without closing the connection.

Documentation EventSource by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

Constructor

new (url:String, ?eventSourceInitDict:EventSourceInit)

Throws:

null DOMError

Variables

onerror:Function

Is an EventHandler being called when an error occurs and the error event is dispatched on this object.

onmessage:Function

Is an EventHandler being called when a message event is received, that is when a message is coming from the source.

onopen:Function

Is an EventHandler being called when an open event is received, that is when the connection was just opened.

read only readyState:Int

An unsigned short representing the state of the connection. Possible values are CONNECTING (0), OPEN (1), or CLOSED (2).

read only url:String

A DOMString representing the URL of the source.

read only withCredentials:Bool

Methods

close ():Void

Closes the connection, if any, and sets the readyState attribute to CLOSED. If the connection is already closed, the method does nothing.

Static variables

@:value(2) static inline read only CLOSED:Int = 2

@:value(0) static inline read only CONNECTING:Int = 0

@:value(1) static inline read only OPEN:Int = 1

© 2005–2018 Haxe Foundation
Licensed under a MIT license.
https://api.haxe.org/js/html/EventSource.html