mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 00:55:37 +00:00
119 lines
4.5 KiB
Plaintext
119 lines
4.5 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** 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) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Malcolm Smith <malsmith@cs.rmit.edu.au>
|
|
*
|
|
* 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"
|
|
|
|
[ptr] native PRFileDescStar(struct PRFileDesc);
|
|
|
|
/**
|
|
* nsISocketProvider
|
|
*/
|
|
[scriptable, uuid(00b3df92-e830-11d8-d48e-0004e22243f8)]
|
|
interface nsISocketProvider : nsISupports
|
|
{
|
|
/**
|
|
* newSocket
|
|
*
|
|
* @param aFamily
|
|
* The address family for this socket (PR_AF_INET or PR_AF_INET6).
|
|
* @param aHost
|
|
* The hostname for this connection.
|
|
* @param aPort
|
|
* The port for this connection.
|
|
* @param aProxyHost
|
|
* If non-null, the proxy hostname for this connection.
|
|
* @param aProxyPort
|
|
* The proxy port for this connection.
|
|
* @param aFlags
|
|
* Control flags that govern this connection (see below.)
|
|
* @param aFileDesc
|
|
* The resulting PRFileDesc.
|
|
* @param aSecurityInfo
|
|
* Any security info that should be associated with aFileDesc. This
|
|
* object typically implements nsITransportSecurityInfo.
|
|
*/
|
|
[noscript]
|
|
void newSocket(in long aFamily,
|
|
in string aHost,
|
|
in long aPort,
|
|
in string aProxyHost,
|
|
in long aProxyPort,
|
|
in unsigned long aFlags,
|
|
out PRFileDescStar aFileDesc,
|
|
out nsISupports aSecurityInfo);
|
|
|
|
/**
|
|
* addToSocket
|
|
*
|
|
* This function is called to allow the socket provider to layer a
|
|
* PRFileDesc on top of another PRFileDesc. For example, SSL via a SOCKS
|
|
* proxy.
|
|
*
|
|
* Parameters are the same as newSocket with the exception of aFileDesc,
|
|
* which is an in-param instead.
|
|
*/
|
|
[noscript]
|
|
void addToSocket(in long aFamily,
|
|
in string aHost,
|
|
in long aPort,
|
|
in string aProxyHost,
|
|
in long aProxyPort,
|
|
in unsigned long aFlags,
|
|
in PRFileDescStar aFileDesc,
|
|
out nsISupports aSecurityInfo);
|
|
|
|
/**
|
|
* PROXY_RESOLVES_HOST
|
|
*
|
|
* This flag is set if the proxy is to perform hostname resolution instead
|
|
* of the client. When set, the hostname parameter passed when in this
|
|
* interface will be used instead of the address structure passed for a
|
|
* later connect et al. request.
|
|
*/
|
|
const long PROXY_RESOLVES_HOST = 1 << 0;
|
|
};
|
|
|
|
%{C++
|
|
/**
|
|
* nsISocketProvider implementations should be registered with XPCOM under a
|
|
* contract ID of the form: "@mozilla.org/network/socket;2?type=foo"
|
|
*/
|
|
#define NS_NETWORK_SOCKET_CONTRACTID_PREFIX \
|
|
"@mozilla.org/network/socket;2?type="
|
|
%}
|