src/net/pterodactylus/fcp/ClientHello.java

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