Web Inspector: Heap: lazily create the agent
[WebKit-https.git] / Source / WebCore / inspector / agents / WebHeapAgent.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "InspectorWebAgentBase.h"
29 #include <JavaScriptCore/InspectorHeapAgent.h>
30 #include <wtf/Forward.h>
31
32 namespace WebCore {
33
34 class SendGarbageCollectionEventsTask;
35 struct GarbageCollectionData;
36 typedef String ErrorString;
37
38 class WebHeapAgent : public Inspector::InspectorHeapAgent {
39     WTF_MAKE_NONCOPYABLE(WebHeapAgent);
40     WTF_MAKE_FAST_ALLOCATED;
41     friend class SendGarbageCollectionEventsTask;
42 public:
43     WebHeapAgent(WebAgentContext&);
44     virtual ~WebHeapAgent();
45
46 protected:
47     void enable(ErrorString&) override;
48     void disable(ErrorString&) override;
49
50     void dispatchGarbageCollectedEvent(Inspector::Protocol::Heap::GarbageCollection::Type, Seconds startTime, Seconds endTime) override;
51
52     void dispatchGarbageCollectionEventsAfterDelay(Vector<GarbageCollectionData>&& collections);
53
54     InstrumentingAgents& m_instrumentingAgents;
55
56     std::unique_ptr<SendGarbageCollectionEventsTask> m_sendGarbageCollectionEventsTask;
57 };
58
59 } // namespace WebCore