src/net/pterodactylus/util/fcp/package-info.java

   1 /**
   2  * Package that holds all the message types that are used in the communication
   3  * with a Freenet Node.
   4  *
   5  * <h2>Usage</h2>
   6  *
   7  * This library was designed to implement the full range of the Freenet Client
   8  * Protocol, Version 2.0. At the moment the library provides a rather low-level
   9  * approach, wrapping each FCP message into its own object but some kind of
  10  * high-level client that does not require any interfaces to be implemented
  11  * will probably provided as well.
  12  *
  13  * So far there are three kinds of approach on using the FCP library in your
  14  * own projects: the {@link net.pterodactylus.util.fcp.FcpListener} method, the
  15  * {@link net.pterodactylus.util.fcp.FcpAdapter} method, and the
  16  * {@link net.pterodactylus.util.fcp.FcpHighLevelClient} method (<em>not yet
  17  * implemented</em>).
  18  *
  19  * For all three methods you need an instance of
  20  * {@link net.pterodactylus.util.fcp.FcpConnection}. Create this to connect to
  21  * your Freenet node.
  22  *
  23  * <pre>
  24  * FcpConnection fcpConnection = new FcpConnection();
  25  * </pre>
  26  *
  27  * <h3>The FcpListener Method</h3>
  28  *
  29  * Implement the {@link net.pterodactylus.util.fcp.FcpListener} interface and
  30  * handle every incoming event.
  31  *
  32  * <pre>
  33  * public class MyClass implements FcpListener {
  34  *
  35  *      public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
  36  *              …
  37  *      }
  38  *
  39  *      // implement all further methods here
  40  *
  41  * }
  42  * </pre>
  43  *
  44  * Next, create
  45  */
  46 package net.pterodactylus.util.fcp;
  47