blob: a462b8a3468cbc2bcf8624ac60cf20ef0acbe1a9 (
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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et ft=cpp : */
/* 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/. */
#ifndef mozilla_net_WebSocketConnectionBase_h
#define mozilla_net_WebSocketConnectionBase_h
// Architecture view:
// Parent Process Socket Process
// ┌─────────────────┐ IPC ┌────────────────────────┐
// │ WebSocketChannel│ ┌─────►WebSocketConnectionChild│
// └─────────┬───────┘ │ └─────────┬──────────────┘
// │ │ │
// ┌──────────▼───────────────┐ │ ┌─────────▼─────────┐
// │ WebSocketConnectionParent├──┘ │WebSocketConnection│
// └──────────────────────────┘ └─────────┬─────────┘
// │
// ┌─────────▼─────────┐
// │ nsSocketTransport │
// └───────────────────┘
// The main reason that we need WebSocketConnectionBase is that we need to
// encapsulate nsSockTransport, nsSocketOutoutStream, and nsSocketInputStream.
// These three objects only live in socket process, so we provide the necessary
// interfaces in WebSocketConnectionBase and WebSocketConnectionListener for
// reading/writing the real socket.
//
// The output path when WebSocketChannel wants to write data to socket:
// - WebSocketConnectionParent::WriteOutputData
// - WebSocketConnectionParent::SendWriteOutputData
// - WebSocketConnectionChild::RecvWriteOutputData
// - WebSocketConnection::WriteOutputData
// - WebSocketConnection::OnOutputStreamReady (writes data to the real socket)
//
// The input path when data is able to read from the socket
// - WebSocketConnection::OnInputStreamReady
// - WebSocketConnectionChild::OnDataReceived
// - WebSocketConnectionChild::SendOnDataReceived
// - WebSocketConnectionParent::RecvOnDataReceived
// - WebSocketChannel::OnDataReceived
//
// The path that WebSocketConnection is constructed.
// - nsHttpChannel::OnStopRequest
// - HttpConnectionMgrShell::CompleteUpgrade
// - HttpConnectionMgrParent::CompleteUpgrade (we store the
// nsIHttpUpgradeListener in a table and send an id to socket process)
// - HttpConnectionMgrParent::SendStartWebSocketConnection
// - HttpConnectionMgrChild::RecvStartWebSocketConnection (the listener id is
// saved in WebSocketConnectionChild and will be used when the socket
// transport is available)
// - WebSocketConnectionChild::Init (an IPC channel between socket thread in
// socket process and background thread in parent process is created)
// - nsHttpConnectionMgr::CompleteUpgrade
// - WebSocketConnectionChild::OnTransportAvailable (WebSocketConnection is
// created)
// - WebSocketConnectionChild::SendOnTransportAvailable
// - WebSocketConnectionParent::RecvOnTransportAvailable
// - WebSocketChannel::OnWebSocketConnectionAvailable
class nsITransportSecurityInfo;
namespace mozilla {
namespace net {
class WebSocketConnectionListener;
class WebSocketConnectionBase : public nsISupports {
public:
virtual nsresult Init(WebSocketConnectionListener* aListener) = 0;
virtual void GetIoTarget(nsIEventTarget** aTarget) = 0;
virtual void Close() = 0;
virtual nsresult WriteOutputData(const uint8_t* aHdrBuf,
uint32_t aHdrBufLength,
const uint8_t* aPayloadBuf,
uint32_t aPayloadBufLength) = 0;
virtual nsresult StartReading() = 0;
virtual void DrainSocketData() = 0;
virtual nsresult GetSecurityInfo(
nsITransportSecurityInfo** aSecurityInfo) = 0;
};
} // namespace net
} // namespace mozilla
#endif // mozilla_net_WebSocketConnectionBase_h
|
