summaryrefslogtreecommitdiffstats
path: root/netwerk/base/nsISpeculativeConnect.idl
blob: e1f890a04b5cc63f034c689686ae5f6d9849eb66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsIPrincipal;
interface nsIURI;
interface nsIInterfaceRequestor;

%{C++
namespace mozilla {

class OriginAttributes;

}
%}

native OriginAttributes(mozilla::OriginAttributes&&);

[scriptable, builtinclass, uuid(d74a17ac-5b8a-4824-a309-b1f04a3c4aed)]
interface nsISpeculativeConnect : nsISupports
{
    /**
     * Called as a hint to indicate a new transaction for the URI is likely coming
     * soon. The implementer may use this information to start a TCP
     * and/or SSL level handshake for that resource immediately so that it is
     * ready and/or progressed when the transaction is actually submitted.
     *
     * No obligation is taken on by the implementer, nor is the submitter obligated
     * to actually open the new channel.
     *
     * @param aURI the URI of the hinted transaction
     * @param aPrincipal the principal that will be used for opening the
     *        channel of the hinted transaction.
     * @param aCallbacks any security callbacks for use with SSL for interfaces.
     *        May be null.
     * @param aAnonymous indicates if this is an anonymous connection.
     *
     */
    void speculativeConnect(in nsIURI aURI,
                            in nsIPrincipal aPrincipal,
                            in nsIInterfaceRequestor aCallbacks,
                            in boolean aAnonymous);

    /**
     * This method is similar to speculativeConnect, but it use
     * the partition key of the originAttributes directly to create the
     * connection.
     */
    [implicit_jscontext]
    void speculativeConnectWithOriginAttributes(
        in nsIURI aURI,
        in jsval originAttributes,
        in nsIInterfaceRequestor aCallbacks,
        in boolean aAnonymous);

    [notxpcom]
    void speculativeConnectWithOriginAttributesNative(
        in nsIURI aURI,
        in OriginAttributes originAttributes,
        in nsIInterfaceRequestor aCallbacks,
        in boolean aAnonymous);
};

/**
 * This is used to override the default values for various values (documented
 * inline) to determine whether or not to actually make a speculative
 * connection.
 */
[uuid(1040ebe3-6ed1-45a6-8587-995e082518d7)]
interface nsISpeculativeConnectionOverrider : nsISupports
{
    /**
     * Used to determine the maximum number of unused speculative connections
     * we will have open for a host at any one time
     */
    [infallible] readonly attribute unsigned long parallelSpeculativeConnectLimit;

    /**
     * Used to determine if we will ignore the existence of any currently idle
     * connections when we decide whether or not to make a speculative
     * connection.
     */
    [infallible] readonly attribute boolean ignoreIdle;

    /*
     * Used by the Predictor to gather telemetry data on speculative connection
     * usage.
     */
    [infallible] readonly attribute boolean isFromPredictor;

    /**
     * by default speculative connections are not made to RFC 1918 addresses
     */
    [infallible] readonly attribute boolean allow1918;
};