← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/netwerk/base/public/nsISocketTransportService.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/netwerk/base/public/nsISocketTransportService.idl
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 * Alternatively, the contents of this file may be used under the terms of
 
25
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 
26
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
27
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
28
 * of those above. If you wish to allow use of your version of this file only
 
29
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
30
 * use your version of this file under the terms of the NPL, indicate your
 
31
 * decision by deleting the provisions above and replace them with the notice
 
32
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
33
 * the provisions above, a recipient may use your version of this file under
 
34
 * the terms of any one of the NPL, the GPL or the LGPL.
 
35
 *
 
36
 * ***** END LICENSE BLOCK ***** */
 
37
 
 
38
#include "nsISupports.idl"
 
39
 
 
40
interface nsISocketTransport;
 
41
interface nsIProxyInfo;
 
42
 
 
43
[scriptable, uuid(05331390-6884-11d3-9382-00104ba0fd40)]
 
44
interface nsISocketTransportService : nsISupports 
 
45
{
 
46
    /**
 
47
     * Creates a transport for a specified host and port.
 
48
     *
 
49
     * @param aSocketTypes
 
50
     *        array of socket type strings.  null if using default socket type.
 
51
     * @param aTypeCount
 
52
     *        specifies length of aSocketTypes.
 
53
     * @param aHost
 
54
     *        specifies the target hostname or IP address literal of the peer
 
55
     *        for this socket.
 
56
     * @param aPort
 
57
     *        specifies the target port of the peer for this socket.
 
58
     * @param aProxyInfo
 
59
     *        specifies the transport-layer proxy type to use.  null if no
 
60
     *        proxy.  used for communicating information about proxies like
 
61
     *        SOCKS (which are transparent to upper protocols).
 
62
     * 
 
63
     * @see nsIProxiedProtocolHandler
 
64
     * @see nsIProtocolProxyService::GetProxyInfo
 
65
     */
 
66
    nsISocketTransport createTransport([array, size_is(aTypeCount)]
 
67
                                       in string aSocketTypes,
 
68
                                       in unsigned long aTypeCount,
 
69
                                       in AUTF8String aHost, 
 
70
                                       in long aPort,
 
71
                                       in nsIProxyInfo aProxyInfo);
 
72
 
 
73
    /**
 
74
     * init/shutdown routines.
 
75
     */
 
76
    void init();
 
77
    void shutdown();
 
78
 
 
79
    /**
 
80
     * controls whether or not the socket transport service should poke
 
81
     * the autodialer on connection failure.
 
82
     */
 
83
    attribute boolean autodialEnabled;
 
84
};