elemental.events

Interface CloseEvent

All Superinterfaces:

Event

All Known Implementing Classes:

JsCloseEvent

public interface CloseEvent
extends Event

A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.

Field Summary

Fields inherited from interface elemental.events.Event

AT_TARGET, BEFORECOPY, BEFORECUT, BEFOREPASTE, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTEXTMENU, COPY, CUT, DBLCLICK, DRAG, DRAGEND, DRAGENTER, DRAGLEAVE, DRAGOVER, DRAGSTART, DROP, ERROR, FOCUS, FOCUSIN, FOCUSOUT, INPUT, INVALID, KEYDOWN, KEYPRESS, KEYUP, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOUSEWHEEL, NONE, PASTE, RESIZE, SCROLL, SELECTSTART, SUBMIT, TOUCHCANCEL, TOUCHEND, TOUCHMOVE, TOUCHSTART, WEBKITANIMATIONEND, WEBKITANIMATIONITERATION, WEBKITANIMATIONSTART, WEBKITTRANSITIONEND

Method Summary

Methods

Modifier and Type	Method and Description
int	getCode() The WebSocket connection close code provided by the server.
String	getReason() A string indicating the reason the server closed the connection.
boolean	isWasClean() Indicates whether or not the connection was cleanly closed.

Methods inherited from interface elemental.events.Event

getClipboardData, getCurrentTarget, getEventPhase, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isBubbles, isCancelable, isCancelBubble, isDefaultPrevented, isReturnValue, preventDefault, setCancelBubble, setReturnValue, stopImmediatePropagation, stopPropagation

Method Detail

getCode

int getCode()

The WebSocket connection close code provided by the server. See Status codes for possible values.

getReason

String getReason()

A string indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.

isWasClean

boolean isWasClean()

Indicates whether or not the connection was cleanly closed.