1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is Mozilla Foundation
18 : * Portions created by the Initial Developer are Copyright (C) 2011
19 : * the Initial Developer. All Rights Reserved.
20 : *
21 : * Contributor(s):
22 : * Mounir Lamouri <mounir.lamouri@mozilla.com> (Original Author)
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef mozilla_dom_network_Connection_h
39 : #define mozilla_dom_network_Connection_h
40 :
41 : #include "nsIDOMConnection.h"
42 : #include "nsDOMEventTargetHelper.h"
43 : #include "nsCycleCollectionParticipant.h"
44 : #include "mozilla/Observer.h"
45 : #include "Types.h"
46 :
47 : namespace mozilla {
48 :
49 : namespace hal {
50 : class NetworkInformation;
51 : } // namespace hal
52 :
53 : namespace dom {
54 : namespace network {
55 :
56 : class Connection : public nsDOMEventTargetHelper
57 : , public nsIDOMMozConnection
58 : , public NetworkObserver
59 0 : {
60 : public:
61 : NS_DECL_ISUPPORTS
62 : NS_DECL_NSIDOMMOZCONNECTION
63 :
64 0 : NS_FORWARD_NSIDOMEVENTTARGET(nsDOMEventTargetHelper::)
65 :
66 : Connection();
67 :
68 : void Init(nsPIDOMWindow *aWindow);
69 : void Shutdown();
70 :
71 : // For IObserver
72 : void Notify(const hal::NetworkInformation& aNetworkInfo);
73 :
74 1464 : NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Connection,
75 : nsDOMEventTargetHelper)
76 :
77 : private:
78 : /**
79 : * Dispatch a trusted non-cancellable and non-bubbling event to itself.
80 : */
81 : nsresult DispatchTrustedEventToSelf(const nsAString& aEventName);
82 :
83 : /**
84 : * Update the connection information stored in the object using a
85 : * NetworkInformation object.
86 : */
87 : void UpdateFromNetworkInfo(const hal::NetworkInformation& aNetworkInfo);
88 :
89 : /**
90 : * If the connection is of a type that can be metered.
91 : */
92 : bool mCanBeMetered;
93 :
94 : /**
95 : * The connection bandwidth.
96 : */
97 : double mBandwidth;
98 :
99 : NS_DECL_EVENT_HANDLER(change)
100 :
101 : static const char* sMeteredPrefName;
102 : static const bool sMeteredDefaultValue;
103 : };
104 :
105 : } // namespace network
106 : } // namespace dom
107 : } // namespace mozilla
108 :
109 : #endif // mozilla_dom_network_Connection_h
|