TCPSocket.onerror

This API is available on Firefox OS for privileged or certified applications only.

Summary

The onerror property is used to specify an event handler to receive error events. Those events are triggered each time an error occurs.

Note: If an error occurs before the connection has been opened, the error was connection refused,
and the close event will not be triggered. If an error occurs after the connection has been opened, the connection was lost, and the close event will be triggered after the error event.

Syntax

instanceOfTCPSocket.onerror = funcRef

Where funcRef is a function to be called when the error event occurs.

This callback function will get a TCPSocketEvent object as its first parameter.

TCPSocketEvent

Such events are simple JavaScript objects with the following properties:

target
The TCPSocket object which fired the event.
type
A string defining the type of the event. Its value can be one of the following: open, error, data, drain, or close.
data
The data related to the event, if any.

In case of error, the data property is a string containing the description of the error.

Specification

Not part of any specification yet; however, this API is discussed at W3C as part of the System Applications Working Group under the Raw Sockets proposal.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, teoli, MHasan, kscarfone, Jeremie
 Last updated by: chrisdavidmills,