Implemented new API for RTCStatsReport object.
[WebKit-https.git] / Source / WebCore / Modules / mediastream / RTCStatsReport.h
1 /*
2  * Copyright (C) 2012 Google 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'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #ifndef RTCStatsReport_h
26 #define RTCStatsReport_h
27
28 #include <wtf/HashMap.h>
29 #include <wtf/PassRefPtr.h>
30 #include <wtf/RefCounted.h>
31 #include <wtf/Vector.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class RTCStatsReport : public RefCounted<RTCStatsReport> {
37 public:
38     static PassRefPtr<RTCStatsReport> create(const String& id, const String& type, double timestamp);
39     // DEPRECATED
40     static PassRefPtr<RTCStatsReport> create();
41
42     double timestamp() const { return m_timestamp; }
43     String id() { return m_id; }
44     String stat(const String& name) { return m_stats.get(name); }
45     Vector<String> names() const;
46
47     // DEPRECATED
48     const PassRefPtr<RTCStatsReport> local();
49     // DEPRECATED
50     const PassRefPtr<RTCStatsReport> remote();
51
52     void addStatistic(const String& name, const String& value);
53     // DEPRECATED
54     void addElement(bool isLocal, double timestamp);
55     // DEPRECATED
56     void addStatistic(bool isLocal, const String& name, const String& value);
57
58 private:
59     RTCStatsReport(const String& id, const String& type, double timestamp);
60
61     String m_id;
62     String m_type;
63     double m_timestamp;
64     HashMap<String, String> m_stats;
65 };
66
67 } // namespace WebCore
68
69 #endif // RTCStatsReport_h