0d16c21317d1c691a2a8f701dbab7f09194049e9
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Protocol / ProtocolTracer.js
1 /*
2  * Copyright (C) 2015 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 WebInspector.ProtocolTracer = class ProtocolTracer extends WebInspector.Object
27 {
28     // Public
29
30     logStarted()
31     {
32         // To be overridden by subclasses.
33     }
34
35     logFrontendException(message, exception)
36     {
37         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
38
39         // To be overridden by subclasses.
40     }
41
42     logProtocolError(message, error)
43     {
44         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
45
46         // To be overridden by subclasses.
47     }
48
49     logFrontendRequest(message)
50     {
51         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
52
53         // To be overridden by subclasses.
54     }
55
56     logWillHandleResponse(message)
57     {
58         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
59
60         // To be overridden by subclasses.
61     }
62
63     logDidHandleResponse(message, timings = null)
64     {
65         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
66
67         // To be overridden by subclasses.
68     }
69
70     logWillHandleEvent(message)
71     {
72         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
73
74         // To be overridden by subclasses.
75     }
76
77     logDidHandleEvent(message, timings = null)
78     {
79         console.assert(typeof message === "string", "Must stringify messages to avoid leaking all JSON protocol messages.")
80
81         // To be overridden by subclasses.
82     }
83
84     logFinished()
85     {
86         // To be overridden by subclasses.
87     }
88 };