Compare Revisions

Monitoring plugins

Change Revisions

Revision 166787:

Revision 166787 by Xrayon on

Revision 166788:

Revision 166788 by Xrayon on

Title:
Monitoring plugins
Monitoring plugins
Slug:
Monitoring_plugins
Monitoring_plugins
Tags:
Add-ons, Plugins, "Firefox 3"
Add-ons, Plugins, "Firefox 3"
Content:

Revision 166787
Revision 166788
n31    <h4 name="Registration">n31    <dl>
32      <dt>
32      Registration33        Registration
34      </dt>
33    </h4>35    </dl>
34    <p>36    <dl>
37      <dd>
35      To register for runtime notifications with the observer ser38        To register for runtime notifications with the observer s
>vice you must create a class with an 'observe' method which recei>ervice you must create a class with an 'observe' method which rec
>ves 3 parameters (subject, topic and data) as well as a 'register>eives 3 parameters (subject, topic and data) as well as a 'regist
>' method that contains the following code:>er' method that contains the following code:
39      </dd>
36    </p>40    </dl>
n42    <h4 name="Observing">n
43      Observing
44    </h4>
n46      As discussed above, to specify what you want done when a non47      <br>
>tification arrives your class must have an 'observe' method, rece 
>iving 3 parameters (subject, topic and data). The topic contains  
>the notification's topic - 'experimental-notify-plugin-call' in t 
>his case, the data is the runtime in milliseconds and the subject 
> is always 'null' and should not be used. 
n48    <p>n49    <dl>
50      <dt>
51        Observing
52      </dt>
53    </dl>
54    <dl>
55      <dd>
56        As discussed above, to specify what you want done when a 
 >notification arrives your class must have an 'observe' method, re
 >ceiving 3 parameters (subject, topic and data). The topic contain
 >s the notification's topic - 'experimental-notify-plugin-call' in
 > this case, the data is the runtime in milliseconds and the subje
 >ct is always 'null' and should not be used.
57      </dd>
58    </dl>
59    <dl>
60      <dd>
49      Here is an example that shows the runtime in an alert box t61        Here is an example that shows the runtime in an alert box
>o the user if the runtime exceeds half a second in length:> to the user if the runtime exceeds half a second in length:
62      </dd>
50    </p>63    </dl>
nn73    <dl>
74      <dd>
75        <b>NOTE: This is just a simplified example and the use of
 > alert() is discouraged as the component can send hundreds of not
 >ifications each second and could potentially cause your browser t
 >o crash if an excessive number of alert boxes are displayed.</b>
76      </dd>
77    </dl>
78    <dl>
79      <dd>
80        Also note that in the example above an if statement first
 > checks to see that the arriving notification's topic is the corr
 >ect one. This is useful in cases where your class is registered t
 >o receive notifications for more than one topic with the observer
 > service.
81      </dd>
82    </dl>
n61      <b>NOTE: This is just a simplified example and the use of an84      <br>
>lert() is discouraged as the component can send hundreds of notif 
>ications each second and could potentially cause your browser to  
>crash if an excessive number of alert boxes are displayed.</b> 
n63    <p>n86    <dl>
64      Also note that in the example above an if statement first c87      <dt>
>hecks to see that the arriving notification's topic is the correc 
>t one. This is useful in cases where your class is registered to  
>receive notifications for more than one topic with the observer s 
>ervice. 
65    </p>
66    <h4 name="Clean_Up">
67      Clean Up88        Clean Up
89      </dt>
68    </h4>90    </dl>
69    <p>91    <dl>
92      <dd>
70      To unregister your class with the observer service - when y93        To unregister your class with the observer service - when
>ou no longer want to be listening to runtime notifications - your> you no longer want to be listening to runtime notifications - yo
> class must include an 'unregister' method that contains the foll>ur class must include an 'unregister' method that contains the fo
>owing code:>llowing code:
94      </dd>
71    </p>95    </dl>
n77    <h4 name="Skeleton_Observer_Class">n
78      Skeleton Observer Class
79    </h4>
n81      Below is a skeleton class that you may use to listen to runn102      <br>
>time notifications: 
tt104    <dl>
105      <dt>
106        Skeleton Observer Class
107      </dt>
108    </dl>
109    <dl>
110      <dd>
111        Below is a skeleton class that you may use to listen to r
 >untime notifications:
112      </dd>
113    </dl>

Back to History