TCPSocket.onclose

by 4 contributors:

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

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

Summary

The onclose property is used to specify an event handler to receive close events. Those events are triggered when the server or the client (with the close() method) closes the connection.

Syntax

instanceOfTCPSocket.onclose = funcRef

Where funcRef is a function to be called when the close 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.

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: teoli, jsx, kscarfone, Jeremie
Last updated by: teoli,