gecko/dom/interfaces/events/nsIDOMCloseEvent.idl
Patrick McManus c9a6067c84 bug 674716 - websockets API close reason codes and messages r=sicking r=biesi sr=bz
--HG--
extra : rebase_source : f7a0eb6b310f29f8e697c26ff5e0ef9d2fde559a
2011-08-03 15:15:25 -04:00

62 lines
2.5 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Wellington Fernando de Macedo.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Wellington Fernando de Macedo <wfernandom2004@gmail.com> (original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsIDOMEvent.idl"
/**
* The nsIDOMCloseEvent interface is the interface to the event
* close on a WebSocket object.
*
* For more information on this interface, please see
* http://dev.w3.org/html5/websockets/#closeevent
*/
[scriptable, uuid(f83d9d6d-6c0c-418c-b12a-438e76d5866b)]
interface nsIDOMCloseEvent : nsIDOMEvent
{
readonly attribute boolean wasClean;
readonly attribute unsigned short code;
readonly attribute DOMString reason;
void initCloseEvent(in DOMString aType,
in boolean aCanBubble,
in boolean aCancelable,
in boolean aWasClean,
in unsigned short aReasonCode,
in DOMString aReason);
};