src/main/java/net/pterodactylus/fcp/ListPeers.java

   1 /*
   2  * jFCPlib - ListPeers.java - Copyright © 2008–2016 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.fcp;
  19
  20 /**
  21  * The “ListPeer” requests asks the node for a list of all peers it has.
  22  *
  23  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  24  */
  25 public class ListPeers extends FcpMessage {
  26
  27         /**
  28          * Creates a new “ListPeers” request that only includes basic data of the
  29          * peers.
  30          *
  31          * @param identifier
  32          *            The identifier of the request
  33          */
  34         public ListPeers(String identifier) {
  35                 this(identifier, false, false);
  36         }
  37
  38         /**
  39          * Creates a new “ListPeers” request that includes wanted data of the
  40          * peers.
  41          *
  42          * @param identifier
  43          *            The identifier of the request
  44          * @param withMetadata
  45          *            If <code>true</code> metadata of the peers is included in the
  46          *            reply
  47          * @param withVolatile
  48          *            if <code>true</code> volatile data of the peers is included
  49          *            in the reply
  50          */
  51         public ListPeers(String identifier, boolean withMetadata, boolean withVolatile) {
  52                 super("ListPeers");
  53                 setField("Identifier", identifier);
  54                 setField("WithMetadata", String.valueOf(withMetadata));
  55                 setField("WithVolatile", String.valueOf(withVolatile));
  56         }
  57
  58 }