Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebCore / platform / network / PingHandle.h
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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PingHandle_h
27 #define PingHandle_h
28
29 #include "ResourceHandle.h"
30 #include "ResourceHandleClient.h"
31 #include "Timer.h"
32
33 namespace WebCore {
34
35 // This class triggers asynchronous loads independent of the networking context staying alive (i.e., auditing pingbacks).
36 // The object just needs to live long enough to ensure the message was actually sent.
37 // As soon as any callback is received from the ResourceHandle, this class will cancel the load and delete itself.
38
39 class PingHandle : private ResourceHandleClient {
40     WTF_MAKE_NONCOPYABLE(PingHandle); WTF_MAKE_FAST_ALLOCATED;
41 public:
42     enum class UsesAsyncCallbacks {
43         Yes,
44         No,
45     };
46     
47     PingHandle(NetworkingContext* networkingContext, const ResourceRequest& request, bool shouldUseCredentialStorage, UsesAsyncCallbacks useAsyncCallbacks)
48         : m_timeoutTimer(*this, &PingHandle::timeoutTimerFired)
49         , m_shouldUseCredentialStorage(shouldUseCredentialStorage)
50         , m_usesAsyncCallbacks(useAsyncCallbacks)
51     {
52         m_handle = ResourceHandle::create(networkingContext, request, this, false, false);
53
54         // If the server never responds, this object will hang around forever.
55         // Set a very generous timeout, just in case.
56         m_timeoutTimer.startOneShot(60000);
57     }
58
59 private:
60     void didReceiveResponse(ResourceHandle*, const ResourceResponse&) override { delete this; }
61     void didReceiveData(ResourceHandle*, const char*, unsigned, int) override { delete this; }
62     void didFinishLoading(ResourceHandle*, double) override { delete this; }
63     void didFail(ResourceHandle*, const ResourceError&) override { delete this; }
64     bool shouldUseCredentialStorage(ResourceHandle*)  override { return m_shouldUseCredentialStorage; }
65     bool usesAsyncCallbacks() override { return m_usesAsyncCallbacks == UsesAsyncCallbacks::Yes; }
66     void timeoutTimerFired() { delete this; }
67
68     virtual ~PingHandle()
69     {
70         if (m_handle)
71             m_handle->cancel();
72     }
73
74     RefPtr<ResourceHandle> m_handle;
75     Timer m_timeoutTimer;
76     bool m_shouldUseCredentialStorage;
77     UsesAsyncCallbacks m_usesAsyncCallbacks;
78 };
79
80 } // namespace WebCore
81
82 #endif // PingHandle_h