mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
118 lines
4.6 KiB
Plaintext
118 lines
4.6 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; 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):
|
|
*
|
|
* 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 nsISocketTransport;
|
|
interface nsIProxyInfo;
|
|
interface nsIRunnable;
|
|
|
|
%{C++
|
|
class nsASocketHandler;
|
|
struct PRFileDesc;
|
|
%}
|
|
|
|
[ptr] native PRFileDescPtr(PRFileDesc);
|
|
[ptr] native nsASocketHandlerPtr(nsASocketHandler);
|
|
|
|
[scriptable, uuid(185B3A5D-8729-436D-9693-7BDCCB9C2216)]
|
|
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
|
|
*
|
|
* NOTE: this function can be called from any thread
|
|
*/
|
|
nsISocketTransport createTransport([array, size_is(aTypeCount)]
|
|
in string aSocketTypes,
|
|
in unsigned long aTypeCount,
|
|
in AUTF8String aHost,
|
|
in long aPort,
|
|
in nsIProxyInfo aProxyInfo);
|
|
|
|
/**
|
|
* Adds a new socket to the list of controlled sockets.
|
|
*
|
|
* This will fail with the error code NS_ERROR_NOT_AVAILABLE if the maximum
|
|
* number of sockets is already reached.
|
|
* In this case, the notifyWhenCanAttachSocket method should be used.
|
|
*
|
|
* @param aFd
|
|
* Open file descriptor of the socket to control.
|
|
* @param aHandler
|
|
* Socket handler that will receive notifications when the socket is
|
|
* ready or detached.
|
|
*
|
|
* NOTE: this function may only be called from an event dispatch on the
|
|
* socket thread.
|
|
*/
|
|
[noscript] void attachSocket(in PRFileDescPtr aFd,
|
|
in nsASocketHandlerPtr aHandler);
|
|
|
|
/**
|
|
* if the number of sockets reaches the limit, then consumers can be
|
|
* notified when the number of sockets becomes less than the limit. the
|
|
* notification is asynchronous, delivered via the given nsIRunnable
|
|
* instance on the socket transport thread.
|
|
*
|
|
* @param aEvent
|
|
* Event that will receive the notification when a new socket can
|
|
* be attached
|
|
*
|
|
* NOTE: this function may only be called from an event dispatch on the
|
|
* socket thread.
|
|
*/
|
|
[noscript] void notifyWhenCanAttachSocket(in nsIRunnable aEvent);
|
|
};
|