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

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