src/main/java/net/pterodactylus/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  * First, create a connection to the node:
  14  *
  15  * <pre>
  16  * FcpConnection fcpConnection = new FcpConnection();
  17  * </pre>
  18  *
  19  * Now implement the {@link net.pterodactylus.fcp.FcpListener} interface
  20  * and handle all incoming events.
  21  *
  22  * <pre>
  23  * public class MyClass implements FcpListener {
  24  *
  25  *      public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
  26  *              …
  27  *      }
  28  *
  29  *      // implement all further methods here
  30  *
  31  * }
  32  * </pre>
  33  */
  34
  35 package net.pterodactylus.fcp;
  36