Make some things that return never-null pointers return references instead.
[WebKit-https.git] / Source / WebCore / Modules / networkinfo / NetworkInfoConnection.h
1 /*
2  * Copyright (C) 2012 Samsung Electronics. 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef NetworkInfoConnection_h
30 #define NetworkInfoConnection_h
31
32 #if ENABLE(NETWORK_INFO)
33 #include "ActiveDOMObject.h"
34 #include "EventListener.h"
35 #include "EventTarget.h"
36 #include "Navigator.h"
37 #include "NetworkInfo.h"
38 #include "NetworkInfoController.h"
39
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/RefCounted.h>
42 #include <wtf/text/WTFString.h>
43
44 namespace WebCore {
45
46 class NetworkInfoController;
47
48 class NetworkInfoConnection : public RefCounted<NetworkInfoConnection>, public EventTarget, public ActiveDOMObject {
49 public:
50     static PassRefPtr<NetworkInfoConnection> create(Navigator*);
51
52     ~NetworkInfoConnection();
53
54     double bandwidth() const;
55     bool metered() const;
56     
57     void didChangeNetworkInformation(PassRefPtr<Event>, PassRefPtr<NetworkInfo>);
58     void networkInfoControllerDestroyed() { m_controller = 0; }
59
60     // EventTarget implementation.
61     virtual const AtomicString& interfaceName() const;
62     virtual ScriptExecutionContext* scriptExecutionContext() const { return ActiveDOMObject::scriptExecutionContext(); }
63
64     using RefCounted<NetworkInfoConnection>::ref;
65     using RefCounted<NetworkInfoConnection>::deref;
66
67     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitnetworkinfochange);
68   
69     // ActiveDOMObject implementation.
70     virtual bool canSuspend() const { return true; }
71     virtual void suspend(ReasonForSuspension);
72     virtual void resume();
73     virtual void stop();
74
75 private:
76     explicit NetworkInfoConnection(Navigator*);
77
78     // EventTarget implementation.
79     virtual EventTargetData* eventTargetData() OVERRIDE;
80     virtual EventTargetData& ensureEventTargetData() OVERRIDE;
81     virtual void refEventTarget() OVERRIDE { ref(); }
82     virtual void derefEventTarget() OVERRIDE { deref(); }
83
84     // EventTarget implementation.
85     EventTargetData m_eventTargetData;
86
87     NetworkInfoController* m_controller;
88     RefPtr<NetworkInfo> m_networkInfo; 
89 };
90
91 } // namespace WebCore
92
93 #endif
94 #endif // NetworkInfoConnection_h