src/main/java/irc/ident/IdentListener.java

   1 /*****************************************************/\r
   2 /*          This java file is a part of the          */\r
   3 /*                                                   */\r
   4 /*           -  Plouf's Java IRC Client  -           */\r
   5 /*                                                   */\r
   6 /*   Copyright (C)  2002 - 2004 Philippe Detournay   */\r
   7 /*                                                   */\r
   8 /*         All contacts : theplouf@yahoo.com         */\r
   9 /*                                                   */\r
  10 /*  PJIRC is free software; you can redistribute     */\r
  11 /*  it and/or modify it under the terms of the GNU   */\r
  12 /*  General Public License as published by the       */\r
  13 /*  Free Software Foundation; version 2 or later of  */\r
  14 /*  the License.                                     */\r
  15 /*                                                   */\r
  16 /*  PJIRC is distributed in the hope that it will    */\r
  17 /*  be useful, but WITHOUT ANY WARRANTY; without     */\r
  18 /*  even the implied warranty of MERCHANTABILITY or  */\r
  19 /*  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU   */\r
  20 /*  General Public License for more details.         */\r
  21 /*                                                   */\r
  22 /*  You should have received a copy of the GNU       */\r
  23 /*  General Public License along with PJIRC; if      */\r
  24 /*  not, write to the Free Software Foundation,      */\r
  25 /*  Inc., 59 Temple Place, Suite 330, Boston,        */\r
  26 /*  MA  02111-1307  USA                              */\r
  27 /*                                                   */\r
  28 /*****************************************************/\r
  29 \r
  30 package irc.ident;\r
  31 \r
  32 /**\r
  33  * The ident server listener.\r
  34  */\r
  35 public interface IdentListener {\r
  36         /**\r
  37          * Error result.\r
  38          */\r
  39         public static final int IDENT_ERROR = -1;\r
  40         /**\r
  41          * Success result.\r
  42          */\r
  43         public static final int IDENT_OK = 0;\r
  44         /**\r
  45          * Replied default user.\r
  46          */\r
  47         public static final int IDENT_DEFAULT = 1;\r
  48         /**\r
  49          * Replied not found user.\r
  50          */\r
  51         public static final int IDENT_NOT_FOUND = 2;\r
  52 \r
  53         /**\r
  54          * The ident server has received a request.\r
  55          * \r
  56          * @param source\r
  57          *          the request source.\r
  58          * @param result\r
  59          *          the request result.\r
  60          * @param reply\r
  61          *          the replied result.\r
  62          */\r
  63         public void identRequested(String source, Integer result, String reply);\r
  64 \r
  65         /**\r
  66          * The ident server is running.\r
  67          * \r
  68          * @param port\r
  69          *          port on wich the server is running.\r
  70          */\r
  71         public void identRunning(Integer port);\r
  72 \r
  73         /**\r
  74          * The ident server is leaving.\r
  75          * \r
  76          * @param message\r
  77          *          leaving message.\r
  78          */\r
  79         public void identLeaving(String message);\r
  80 \r
  81 }\r