summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/api/webSocketProxyPrivate.json
blob: 4afa79275cdb30a42249a92df9b6fbb8860b1951 (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
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

[
  {
    "namespace": "webSocketProxyPrivate",
    "nodoc": true,
    "types": [],
    "functions": [
      {
        "name": "getPassportForTCP",
        "description": "requests authorization token for websocket to TCP proxy.",
        "parameters": [
          {
            "type": "string",
            "name": "hostname",
            "minLength": 1,
            "description": "hostname to which TCP connection is requested."
          },
          {
            "type": "integer",
            "name": "port",
            "minimum": 1,
            "maximum": 65535,
            "description": "TCP port number."
          },
          {
            "type": "function",
            "name": "callback",
            "parameters": [
              {
                "type": "string",
                "name": "passport",
                "description": "Passport for passing to proxy."
              }
            ]
          }
        ]
      },
      {
        "name": "getURLForTCP",
        "description": "requests specific websocket URL that can be used as TCP proxy.",
        "parameters": [
          {
            "type": "string",
            "name": "hostname",
            "minLength": 1,
            "description": "hostname to which TCP connection is requested."
          },
          {
            "type": "integer",
            "name": "port",
            "minimum": 1,
            "maximum": 65535,
            "description": "TCP port number."
          },
          {
            "type": "object",
            "name": "details",
            "description": "Dictionary which contains requested parameters of connection",
            "properties": {
              "tls": {"type": "boolean", "optional": "true", "description": "whether TLS over TCP is requested"}
            }
          },
          {
            "type": "function",
            "name": "callback",
            "parameters": [
              {
                "type": "string",
                "name": "url",
                "description": "URL for opening as WebSocket."
              }
            ]
          }
        ]
      }
    ],
    "events": []
  }
]