зеркало из https://github.com/mozilla/pjs.git
150 строки
5.7 KiB
Plaintext
150 строки
5.7 KiB
Plaintext
/* -*- Mode: IDL; 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):
|
|
*
|
|
* 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 "nsITransport.idl"
|
|
|
|
interface nsIInterfaceRequestor;
|
|
|
|
native PRNetAddr(union PRNetAddr);
|
|
|
|
/**
|
|
* nsISocketTransport
|
|
*
|
|
* NOTE: Connection setup is triggered by opening an input or output stream,
|
|
* it does not start on its own. Completion of the connection setup is
|
|
* indicated by a STATUS_CONNECTED_TO notification to the event sink (if set).
|
|
*
|
|
* NOTE: This is a free-threaded interface, meaning that the methods on
|
|
* this interface may be called from any thread.
|
|
*/
|
|
[scriptable, uuid(66418cc8-5f5d-4f52-a7f9-db8fb3b2cfe6)]
|
|
interface nsISocketTransport : nsITransport
|
|
{
|
|
/**
|
|
* Get the host for the underlying socket connection.
|
|
*/
|
|
readonly attribute AUTF8String host;
|
|
|
|
/**
|
|
* Get the port for the underlying socket connection.
|
|
*/
|
|
readonly attribute long port;
|
|
|
|
/**
|
|
* Returns the IP address of the socket connection peer. This
|
|
* attribute is defined only once a connection has been established.
|
|
*/
|
|
[noscript] PRNetAddr getPeerAddr();
|
|
|
|
/**
|
|
* Returns the IP address of the initiating end. This attribute
|
|
* is defined only once a connection has been established.
|
|
*/
|
|
[noscript] PRNetAddr getSelfAddr();
|
|
|
|
/**
|
|
* Security info object returned from the secure socket provider. This
|
|
* object supports nsISSLSocketControl, nsITransportSecurityInfo, and
|
|
* possibly other interfaces.
|
|
*
|
|
* This attribute is only available once the socket is connected.
|
|
*/
|
|
readonly attribute nsISupports securityInfo;
|
|
|
|
/**
|
|
* Security notification callbacks passed to the secure socket provider
|
|
* via nsISSLSocketControl at socket creation time.
|
|
*
|
|
* NOTE: this attribute cannot be changed once a stream has been opened.
|
|
*/
|
|
attribute nsIInterfaceRequestor securityCallbacks;
|
|
|
|
/**
|
|
* Test if this socket transport is (still) connected.
|
|
*/
|
|
boolean isAlive();
|
|
|
|
/**
|
|
* Socket timeouts in seconds. To specify no timeout, pass PR_UINT32_MAX
|
|
* as aValue to setTimeout. The implementation may truncate timeout values
|
|
* to a smaller range of values (e.g., 0 to 0xFFFF).
|
|
*/
|
|
unsigned long getTimeout(in unsigned long aType);
|
|
void setTimeout(in unsigned long aType, in unsigned long aValue);
|
|
|
|
/**
|
|
* Values for the aType parameter passed to get/setTimeout.
|
|
*/
|
|
const unsigned long TIMEOUT_CONNECT = 0;
|
|
const unsigned long TIMEOUT_READ_WRITE = 1;
|
|
|
|
/**
|
|
* nsITransportEventSink status codes.
|
|
*
|
|
* Although these look like XPCOM error codes and are passed in an nsresult
|
|
* variable, they are *not* error codes. Note that while they *do* overlap
|
|
* with existing error codes in Necko, these status codes are confined
|
|
* within a very limited context where no error codes may appear, so there
|
|
* is no ambiguity.
|
|
*
|
|
* The values of these status codes must never change.
|
|
*
|
|
* The status codes appear in near-chronological order (not in numeric
|
|
* order). STATUS_RESOLVING may be skipped if the host does not need to be
|
|
* resolved. STATUS_WAITING_FOR is an optional status code, which the impl
|
|
* of this interface may choose not to generate.
|
|
*/
|
|
const unsigned long STATUS_RESOLVING = 0x804b0003;
|
|
const unsigned long STATUS_CONNECTING_TO = 0x804b0007;
|
|
const unsigned long STATUS_CONNECTED_TO = 0x804b0004;
|
|
const unsigned long STATUS_SENDING_TO = 0x804b0005;
|
|
const unsigned long STATUS_WAITING_FOR = 0x804b000a;
|
|
const unsigned long STATUS_RECEIVING_FROM = 0x804b0006;
|
|
};
|
|
|
|
%{C++
|
|
/**
|
|
* #define's for compatibility
|
|
*/
|
|
#define NS_NET_STATUS_RESOLVING_HOST nsISocketTransport::STATUS_RESOLVING
|
|
#define NS_NET_STATUS_CONNECTED_TO nsISocketTransport::STATUS_CONNECTED_TO
|
|
#define NS_NET_STATUS_SENDING_TO nsISocketTransport::STATUS_SENDING_TO
|
|
#define NS_NET_STATUS_RECEIVING_FROM nsISocketTransport::STATUS_RECEIVING_FROM
|
|
#define NS_NET_STATUS_CONNECTING_TO nsISocketTransport::STATUS_CONNECTING_TO
|
|
#define NS_NET_STATUS_WAITING_FOR nsISocketTransport::STATUS_WAITING_FOR
|
|
%}
|