Back to index

lightning-sunbird  0.9+nobinonly
nsISocketTransport.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsITransport.idl"
00039 
00040 interface nsIInterfaceRequestor;
00041 interface nsISocketEventSink;
00042 
00043 native PRNetAddr(union PRNetAddr);
00044 
00051 [scriptable, uuid(66418cc8-5f5d-4f52-a7f9-db8fb3b2cfe6)]
00052 interface nsISocketTransport : nsITransport 
00053 {
00057     readonly attribute AUTF8String host;
00058 
00062     readonly attribute long port;
00063 
00068     [noscript] PRNetAddr getPeerAddr();
00069 
00074     [noscript] PRNetAddr getSelfAddr();
00075 
00081     readonly attribute nsISupports securityInfo;
00082     
00089     attribute nsIInterfaceRequestor securityCallbacks;
00090    
00094     boolean isAlive();
00095 
00101     unsigned long getTimeout(in unsigned long aType);
00102     void          setTimeout(in unsigned long aType, in unsigned long aValue);
00103 
00107     const unsigned long TIMEOUT_CONNECT    = 0;
00108     const unsigned long TIMEOUT_READ_WRITE = 1;
00109 
00126     const unsigned long STATUS_RESOLVING      = 0x804b0003;
00127     const unsigned long STATUS_CONNECTING_TO  = 0x804b0007;
00128     const unsigned long STATUS_CONNECTED_TO   = 0x804b0004;
00129     const unsigned long STATUS_SENDING_TO     = 0x804b0005;
00130     const unsigned long STATUS_WAITING_FOR    = 0x804b000a;
00131     const unsigned long STATUS_RECEIVING_FROM = 0x804b0006;
00132 };
00133 
00134 %{C++
00138 #define NS_NET_STATUS_RESOLVING_HOST nsISocketTransport::STATUS_RESOLVING
00139 #define NS_NET_STATUS_CONNECTED_TO   nsISocketTransport::STATUS_CONNECTED_TO
00140 #define NS_NET_STATUS_SENDING_TO     nsISocketTransport::STATUS_SENDING_TO
00141 #define NS_NET_STATUS_RECEIVING_FROM nsISocketTransport::STATUS_RECEIVING_FROM
00142 #define NS_NET_STATUS_CONNECTING_TO  nsISocketTransport::STATUS_CONNECTING_TO
00143 #define NS_NET_STATUS_WAITING_FOR    nsISocketTransport::STATUS_WAITING_FOR
00144 %}