View Javadoc

1   /*
2    * Copyright (c) 2005 The University of Reading
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    * 1. Redistributions of source code must retain the above copyright
9    *    notice, this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright
11   *    notice, this list of conditions and the following disclaimer in the
12   *    documentation and/or other materials provided with the distribution.
13   * 3. Neither the name of the University of Reading, nor the names of the
14   *    authors or contributors may be used to endorse or promote products
15   *    derived from this software without specific prior written permission.
16   * 
17   * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20   * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   */
28  
29  package uk.ac.rdg.resc.jstyx.client;
30  
31  /***
32   * Interface defining events that are fired when a StyxConnection has been
33   * successfully opened or closed, or when an error occurs
34   *
35   * @author Jon Blower
36   * $Revision: 236 $
37   * $Date: 2005-05-16 14:09:54 +0100 (Mon, 16 May 2005) $
38   * $Log$
39   * Revision 1.3  2005/05/16 13:09:54  jonblower
40   * Added StyxConnection object as first argument in all StyxConnectionListener methods
41   *
42   * Revision 1.2  2005/02/21 18:09:43  jonblower
43   * *** empty log message ***
44   *
45   * Revision 1.1.1.1  2005/02/16 18:58:19  jonblower
46   * Initial import
47   *
48   */
49  public interface StyxConnectionListener
50  {
51      
52      /***
53       * Called when the relevant handshaking has been performed and the connection
54       * is ready for Styx messages to be sent
55       */
56      public void connectionReady(StyxConnection conn);
57      
58      /***
59       * Called when the connection has been closed
60       */
61      public void connectionClosed(StyxConnection conn);
62      
63      /***
64       * Called when an error has occurred when connecting.
65       * @param message String describing the problem
66       */
67      public void connectionError(StyxConnection conn, String message);
68      
69  }