src/net/pterodactylus/fcp/WatchGlobal.java

   1 /*
   2  * jSite2 - WatchGlobal.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 /**
  23  * The “WatchGlobal” messages enables clients to watch the global queue in
  24  * addition to the client-local queue.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class WatchGlobal extends FcpMessage {
  29
  30         /**
  31          * Enables or disables watching the global queue.
  32          *
  33          * @param enabled
  34          *            <code>true</code> to watch the global queue and the
  35          *            client-local queue, <code>false</code> to watch only the
  36          *            client-local queue
  37          */
  38         public WatchGlobal(boolean enabled) {
  39                 this(enabled, Verbosity.ALL);
  40         }
  41
  42         /**
  43          * Enables or disables watching the global queue, optionally masking out
  44          * certain events.
  45          *
  46          * @param enabled
  47          *            <code>true</code> to watch the global queue and the
  48          *            client-local queue, <code>false</code> to watch only the
  49          *            client-local queue
  50          * @param verbosityMask
  51          *            A verbosity mask that determines which events are received
  52          */
  53         public WatchGlobal(boolean enabled, Verbosity verbosityMask) {
  54                 super("WatchGlobal");
  55                 setField("Enabled", String.valueOf(enabled));
  56                 setField("VerbosityMask", String.valueOf(verbosityMask));
  57         }
  58
  59 }