summaryrefslogtreecommitdiffstats
path: root/dom/plugins/ipc/MiniShmParent.h
blob: 06eec62560fccb8822aaf4ea733d7c66995e0ac5 (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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* 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_plugins_MiniShmParent_h
#define mozilla_plugins_MiniShmParent_h

#include "MiniShmBase.h"

#include <string>

namespace mozilla {
namespace plugins {

/**
 * This class provides a lightweight shared memory interface for a parent
 * process in Win32.
 * This code assumes that there is a parent-child relationship between
 * processes, as it creates inheritable handles.
 * Note that this class is *not* an IPDL actor.
 *
 * @see MiniShmChild
 */
class MiniShmParent : public MiniShmBase {
 public:
  MiniShmParent();
  virtual ~MiniShmParent();

  static const unsigned int kDefaultMiniShmSectionSize;

  /**
   * Initialize shared memory on the parent side.
   *
   * @param aObserver A MiniShmObserver object to receive event notifications.
   * @param aTimeout Timeout in milliseconds.
   * @param aSectionSize Desired size of the shared memory section. This is
   *                     expected to be a multiple of 0x1000 (4KiB).
   * @return nsresult error code
   */
  nsresult Init(MiniShmObserver* aObserver, const DWORD aTimeout,
                const unsigned int aSectionSize = kDefaultMiniShmSectionSize);

  /**
   * Destroys the shared memory section. Useful to explicitly release
   * resources if it is known that they won't be needed again.
   */
  void CleanUp();

  /**
   * Provides a cookie string that should be passed to MiniShmChild
   * during its initialization.
   *
   * @param aCookie A std::wstring variable to receive the cookie.
   * @return nsresult error code
   */
  nsresult GetCookie(std::wstring& aCookie);

  virtual nsresult Send() override;

  bool IsConnected() const;

 protected:
  void OnEvent() override;

 private:
  void FinalizeConnection();

  unsigned int mSectionSize;
  HANDLE mParentEvent;
  HANDLE mParentGuard;
  HANDLE mChildEvent;
  HANDLE mChildGuard;
  HANDLE mRegWait;
  HANDLE mFileMapping;
  LPVOID mView;
  bool mIsConnected;
  DWORD mTimeout;

  DISALLOW_COPY_AND_ASSIGN(MiniShmParent);
};

}  // namespace plugins
}  // namespace mozilla

#endif  // mozilla_plugins_MiniShmParent_h