RetroZilla/extensions/webservices/public/nsISOAPResponseListener.idl
2015-10-20 23:03:22 -04:00

79 lines
3.4 KiB
Plaintext

/* -*- Mode: C++; 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
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either 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 "nsISupports.idl"
interface nsISOAPCall;
interface nsISOAPResponse;
/**
* This interface represents a response handler to be invoked whenever
* a response of a particular call is recieved and when no more
* responses are expected.
*/
[scriptable, function,
uuid(99ec6692-535f-11d4-9a58-000064657374)]
interface nsISOAPResponseListener : nsISupports {
/**
* This method is invoked when we receive an asynchronous response to
* a SOAP message. The listener is registered as part of the original
* asynchronous call invocation.
*
* @param aResponse The decoded version of the response. If an
* error occurred transmitting the response, the status field
* of the response will contain an error code. The last call
* to the listener may contain a null response, which should
* only be interpreted as an error if your call expected more
* results than it got. If the service or the transport
* do not know whether to expect more results, then setting
* the last parameter true may only be possible after the
* last response has already been delivered.
*
* @param aLast True if this is the last call to the listener.
*
* @return True to make this the last call to the listener, even
* if last was not true. Calls which expect a single response
* should return true upon receiving that response to avoid
* possibly recieving another callback with a null response
* indicating that the last response was already sent.
*/
boolean handleResponse(in nsISOAPResponse aResponse,
in nsISOAPCall aCall, in unsigned long status,
in boolean aLast);
};