mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-28 04:35:33 +00:00
ca53676a88
Inherited SOAPParameter and SOAPHeaderBlock from SOAPBlock, improved error condition handling, improved comments. Not part of default build.
104 lines
4.0 KiB
Plaintext
104 lines
4.0 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* 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 Netscape are
|
|
* Copyright (C) 2001 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
#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="
|
|
%}
|