View Javadoc

1   /***
2    * Jetrix TetriNET Server
3    * Copyright (C) 2005  Emmanuel Bourg
4    *
5    * This program is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU General Public License
7    * as published by the Free Software Foundation; either version 2
8    * of the License, or (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.jetrix.agent;
21  
22  import net.jetrix.Message;
23  
24  import java.io.IOException;
25  
26  /***
27   * An agent is a client able to connect to a server.
28   *
29   * @since 0.2
30   *
31   * @author Emmanuel Bourg
32   * @version $Revision: 794 $, $Date: 2009-02-17 20:08:39 +0100 (Tue, 17 Feb 2009) $
33   */
34  public interface Agent
35  {
36      /***
37       * Connect to the specified server.
38       *
39       * @param hostname the name or ip of the server
40       */
41      void connect(String hostname) throws IOException;
42  
43      /***
44       * Disconnect from the server.
45       */
46      void disconnect() throws IOException;
47  
48      /***
49       * Send a message to the server.
50       *
51       * @param message the message to send
52       */
53      void send(Message message) throws IOException;
54  
55      /***
56       * Receive a message sent by the server.
57       * 
58       * @param message
59       * @throws IOException
60       */
61      void receive(Message message) throws IOException;
62  }