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

   1 /*
   2  * jFCPlib - ClientHello.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  * A “ClientHello” message that <i>must</i> be sent to the node first thing
  22  * after calling {@link FcpConnection#connect()}.
  23  *
  24  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  25  */
  26 public class ClientHello extends FcpMessage {
  27
  28         /**
  29          * Creates a new “ClientHello” message with the given client name. The
  30          * client name has to be unique to the node otherwise you will get a
  31          * {@link CloseConnectionDuplicateClientName} response from the node!
  32          *
  33          * @param clientName
  34          *            The unique client name
  35          */
  36         public ClientHello(String clientName) {
  37                 this(clientName, "2.0");
  38         }
  39
  40         /**
  41          * Creates a new “ClientHello” message with the given client name. The
  42          * client name has to be unique to the node otherwise you will get a
  43          * {@link CloseConnectionDuplicateClientName} response from the node! The
  44          * expected FCP version is currently ignored by the node.
  45          *
  46          * @param clientName
  47          *            The unique client name
  48          * @param expectedVersion
  49          *            The FCP version that the node is expected to talk
  50          */
  51         public ClientHello(String clientName, String expectedVersion) {
  52                 super("ClientHello");
  53                 setField("Name", clientName);
  54                 setField("ExpectedVersion", expectedVersion);
  55         }
  56
  57 }