Subversion Repositories svnkaklik

Rev

Details | Last modification | View Log

Rev Author Line No. Line
157 kaklik 1
/*
2
    AVRcamVIEW: A PC application to test out the functionallity of the
3
     AVRcam real-time image processing engine.
4
    Copyright (C) 2004    Brent A. Taylor
5
 
6
    This program is free software; you can redistribute it and/or
7
    modify it under the terms of the GNU General Public
8
    License as published by the Free Software Foundation; either
9
    version 2 of the License, or (at your option) any later version.
10
 
11
    This program is distributed in the hope that it will be useful,
12
    but WITHOUT ANY WARRANTY; without even the implied warranty of
13
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
    General Public License for more details.
15
 
16
    You should have received a copy of the GNU General Public
17
    License along with this program; if not, write to the Free Software
18
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
 
20
   For more information on the AVRcamVIEW, please contact:
21
 
22
   taylorba@comcast.net
23
 
24
   or go to www.jrobot.net for more details regarding the system.
25
*/
26
 
27
package avr.connection;
28
 
29
import java.io.*;
30
import java.nio.channels.*;
31
 
32
/***********************************************************************
33
 * Defines methods for some type of I/O Connection.
34
 */
35
public interface Connection {
36
 
37
   /**
38
    * Connects this connection.
39
    * @throws IOException If the connection could not be connected.
40
    */
41
   public void connect() throws Exception;
42
 
43
   /**
44
    * Disconnects this connection.
45
    * @throws IOException If the connection could not be disconnected.
46
    */
47
   public void disconnect() throws IOException;
48
 
49
   /**
50
    * Returns the Object to which this connection is wrapped around.
51
    * @return The Object to which this connection is wrapped around.
52
    */
53
   public Object getConnectionObject();
54
 
55
   /**
56
    * Tells whether or not this connection is connected.
57
    * @return true if, and only if, this connection is connected.
58
    */
59
   public boolean isConnected();
60
 
61
   /**
62
    * Returns the InputStream associated with this connection.
63
    * @return The InputStream associated with this connection.
64
    * @throws IOException If the InputStream could not be returned.
65
    */
66
   public InputStream getInputStream() throws IOException;
67
 
68
   /**
69
    * Returns the OutputStream associated with this connection.
70
    * @return The OutputStream associated with this connection.
71
    * @throws IOException If the OutputStream could not be returned.
72
    */
73
   public OutputStream getOutputStream() throws IOException;
74
 
75
   /**
76
    * Returns the ByteChannel associated with this connection.
77
    * @return The ByteChannel associated with this connection.
78
    */
79
   public ByteChannel getChannel();
80
 
81
}