gecko-dev/extensions/webservices/public/nsISOAPTransport.idl
rayw%netscape.com e3f8c4ff5c Whitespace fixes.
SOAP is not part of default build.
2002-02-15 10:48:16 +00:00

121 lines
5.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 NPL, 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 NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsISOAPTransportListener;
interface nsISOAPCall;
interface nsISOAPResponse;
interface nsISOAPResponseListener;
interface nsISOAPCallCompletion;
[scriptable, uuid(99ec6695-535f-11d4-9a58-000064657374)]
interface nsISOAPTransport : nsISupports {
/**
* Send the specified message to the specified destination.
* This will fail if synchronous calls are not supported or if there is any
* failure in the actual message exchange. Failure of the call itself will be
* contained in the response.
*
* @param aCall Actual message to be sent.
*
* @param aResponse Message to be recieved. Calling synchronously assumes that
* exactly one response is expected.
*/
void syncCall(in nsISOAPCall aCall, in nsISOAPResponse aResponse);
/**
* Send the specified message to the specified destination synchronously waiting
* for completion and any response.
* This will fail if there is any failure in the setup of the message exchange.
* Later errors will only be known through the response listener. Failures of the
* call itself will be contained in the response passed to the response listener.
*
* @param aCall Actual message to be sent.
*
* @param aListener Handler to be invoked (single threaded) as each response is
* received and finally with null. If specified as null, no responses are returned.
*
* @param response Message to recieve response and be handled by listener. May be
* null if listener is null.
*/
nsISOAPCallCompletion asyncCall(in nsISOAPCall aCall,
in nsISOAPResponseListener aListener,
in nsISOAPResponse aResponse);
/**
* Add listener for unsolicited messages arriving on the transport. Listeners
* are provided with the opportunity to accept and process messages. Typically
* a listener will be a service dispatcher. Listeners will be invoked in the
* reverse order of declaration, allowing more local service dispatchers to
* temporarily override permanent service dispatchers. This will fail if the
* desired listener was already added to the transport with the specified
* capture flag or if the transport does not support incoming messages.
*
* @param aListener The listener to recieve unsolicited messages from the
* transport.
*
* @param aCapture True if the listener should capture the message before
* later-declared services.
*/
void addListener(in nsISOAPTransportListener aListener,
in boolean aCapture);
/**
* Remove listener for unsolicited messages arriving on the transport. This
* will fail if the specified listener was not added with the specified
* capture setting.
*
* @param aListener The listener to stop from recieving unsolicited messages
* from the transport.
*
* @param aCapture True if the listener was added to capture the message before
* later-declared services (must be specified to remove, since a listener
* may be registered as both).
*/
void removeListener(in nsISOAPTransportListener aListener,
in boolean aCapture);
};
%{C++
#define NS_SOAPTRANSPORT_CONTRACTID \
"@mozilla.org/xmlextras/soap/transport;1"
#define NS_SOAPTRANSPORT_CONTRACTID_PREFIX NS_SOAPTRANSPORT_CONTRACTID "?protocol="
%}