mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-20 16:55:40 +00:00
117 lines
4.6 KiB
Plaintext
117 lines
4.6 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** 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) 1998
|
|
* 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 nsISocketTransport;
|
|
interface nsISocketEventHandler;
|
|
interface nsIProxyInfo;
|
|
|
|
[scriptable, uuid(05331390-6884-11d3-9382-00104ba0fd40)]
|
|
interface nsISocketTransportService : nsISupports
|
|
{
|
|
/**
|
|
* Creates a transport for a specified host and port.
|
|
*
|
|
* @param aSocketTypes
|
|
* array of socket type strings. null if using default socket type.
|
|
* @param aTypeCount
|
|
* specifies length of aSocketTypes.
|
|
* @param aHost
|
|
* specifies the target hostname or IP address literal of the peer
|
|
* for this socket.
|
|
* @param aPort
|
|
* specifies the target port of the peer for this socket.
|
|
* @param aProxyInfo
|
|
* specifies the transport-layer proxy type to use. null if no
|
|
* proxy. used for communicating information about proxies like
|
|
* SOCKS (which are transparent to upper protocols).
|
|
*
|
|
* @see nsIProxiedProtocolHandler
|
|
* @see nsIProtocolProxyService::GetProxyInfo
|
|
*/
|
|
nsISocketTransport createTransport([array, size_is(aTypeCount)]
|
|
in string aSocketTypes,
|
|
in unsigned long aTypeCount,
|
|
in AUTF8String aHost,
|
|
in long aPort,
|
|
in nsIProxyInfo aProxyInfo);
|
|
|
|
/**
|
|
* init/shutdown routines.
|
|
*/
|
|
void init();
|
|
void shutdown();
|
|
|
|
/**
|
|
* Post an event to be executed on the socket thread.
|
|
*
|
|
* @param aHandler
|
|
* handler that will be executed on the socket thread.
|
|
* @param aType
|
|
* caller defined message parameter
|
|
* @param aUParam
|
|
* caller defined message parameter
|
|
* @param aVParam
|
|
* caller defined message parameter
|
|
*
|
|
* The socket transport service treats each parameter as opaque data (i.e.,
|
|
* it is not responsible for cleaning up aVParam if it happens to be
|
|
* dynamically allocated). If this function succeeds, then the message
|
|
* will be delivered. All messages successfully posted will be delivered
|
|
* before the socket transport service shuts down.
|
|
*/
|
|
[noscript] void postEvent(in nsISocketEventHandler aHandler,
|
|
in unsigned long aType,
|
|
in unsigned long aUParam,
|
|
in voidPtr aVParam);
|
|
|
|
/**
|
|
* controls whether or not the socket transport service should poke
|
|
* the autodialer on connection failure.
|
|
*/
|
|
attribute boolean autodialEnabled;
|
|
};
|
|
|
|
[uuid(c20f98be-b3e4-4f9b-a492-97a688577355)]
|
|
interface nsISocketEventHandler : nsISupports
|
|
{
|
|
[noscript] void onSocketEvent(in unsigned long aType,
|
|
in unsigned long aUParam,
|
|
in voidPtr aVParam);
|
|
};
|