summaryrefslogtreecommitdiffstats
path: root/ipc/glue/MessageLink.h
blob: 504867ee82db0a917bd44ad8ec7419a6a9695f64 (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
99
100
101
102
103
104
105
106
107
108
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=4 et :
 */
/* 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 ipc_glue_MessageLink_h
#define ipc_glue_MessageLink_h 1

#include <cstdint>
#include "base/message_loop.h"
#include "mojo/core/ports/node.h"
#include "mojo/core/ports/port_ref.h"
#include "mozilla/Assertions.h"
#include "mozilla/UniquePtr.h"
#include "mozilla/ipc/ScopedPort.h"

namespace IPC {
class Message;
class MessageReader;
class MessageWriter;
}  // namespace IPC

namespace mozilla {
namespace ipc {

class MessageChannel;
class NodeController;

struct HasResultCodes {
  enum Result {
    MsgProcessed,
    MsgDropped,
    MsgNotKnown,
    MsgNotAllowed,
    MsgPayloadError,
    MsgProcessingError,
    MsgRouteError,
    MsgValueError
  };
};

enum Side : uint8_t { ParentSide, ChildSide, UnknownSide };

class MessageLink {
 public:
  typedef IPC::Message Message;

  explicit MessageLink(MessageChannel* aChan);
  virtual ~MessageLink();

  // n.b.: These methods all require that the channel monitor is
  // held when they are invoked.
  virtual void SendMessage(mozilla::UniquePtr<Message> msg) = 0;
  virtual void SendClose() = 0;

  virtual bool IsClosed() const = 0;

#ifdef FUZZING_SNAPSHOT
  virtual Maybe<mojo::core::ports::PortName> GetPortName() { return Nothing(); }
#endif

 protected:
  MessageChannel* mChan;
};

class PortLink final : public MessageLink {
  using PortRef = mojo::core::ports::PortRef;
  using PortStatus = mojo::core::ports::PortStatus;
  using UserMessage = mojo::core::ports::UserMessage;
  using UserMessageEvent = mojo::core::ports::UserMessageEvent;

 public:
  PortLink(MessageChannel* aChan, ScopedPort aPort);
  virtual ~PortLink();

  void SendMessage(UniquePtr<Message> aMessage) override;
  void SendClose() override;

  bool IsClosed() const override;

#ifdef FUZZING_SNAPSHOT
  Maybe<mojo::core::ports::PortName> GetPortName() override {
    return Some(mPort.name());
  }
#endif

 private:
  class PortObserverThunk;
  friend class PortObserverThunk;

  void OnPortStatusChanged();

  // Called either when an error is detected on the port from the port observer,
  // or when `SendClose()` is called.
  void Clear();

  const RefPtr<NodeController> mNode;
  const PortRef mPort;

  RefPtr<PortObserverThunk> mObserver;
};

}  // namespace ipc
}  // namespace mozilla

#endif  // ifndef ipc_glue_MessageLink_h