server/filter/TCPReader.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.filter;

//---IMPORTS---
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.componentmanager.*;
import uk.ac.ukc.iscream.filter.*;
import java.net.Socket;
import java.net.ServerSocket;
import java.io.OutputStream;
import java.io.IOException;
import java.net.InetAddress;
import java.net.UnknownHostException;
import uk.ac.ukc.iscream.util.*;

/**
 * Reads TCP Heartbeats from the host applications.
 *
 * @author  $Author: tdb1 $
 * @version $Id: TCPReader.java,v 1.7 2001/01/18 23:15:50 tdb1 Exp $
 */
class TCPReader extends Thread {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.7 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

        /**
     * Constructs a new TCPReader
     *
     * @param queue A reference to our Queue
         * @param port The port that the TCPReader will listen on
         */
    public TCPReader(int port, Queue queue) {
        _port = port;
        _queue = queue;
        _logger.write(toString(), Logger.SYSINIT, "started");
    }

    

//---PUBLIC METHODS---

        /**
         * The run() method is the main loop for this thread, and we
         * will remain in here until such a point as something goes
         * wrong with the listening. After initially setting up the
         * ServerSocket we go round a while loop receiving connections
         * and then passing them off to other processes to deal with.
         */
    public void run(){
        ServerSocket listenPort=null;
                // We use this boolean so we can break out of the while loop if we want
        boolean run = true;
        try{
                        // Setup the ServerSocket so that clients can connect
            listenPort = new ServerSocket(_port);
        }
        catch(IOException e){
        }
                // Log what machine/port we're listening on
                try{
                        _logger.write(toString(), Logger.SYSMSG, "TCPReader listening on "
                                                                                +InetAddress.getLocalHost().getHostName()
                                                                                +"/"+InetAddress.getLocalHost().getHostAddress()
                                                                                +" port "+listenPort.getLocalPort());
                }
                catch(UnknownHostException e){
                        _logger.write(toString(), Logger.SYSMSG, "TCPReader listening on UnknownHost "
                                                                                +"port "+listenPort.getLocalPort());
                }
                // Loop round constantly until we decide to stop
        while(run){
            Socket hostSocket=null;
            try{
                _logger.write(toString(), Logger.SYSMSG, "Waiting for Connection");
                                // This will block until a host connects - at which point we get a Socket
                hostSocket = listenPort.accept();
                _logger.write(toString(), Logger.SYSMSG, "Connection accepted from: " + hostSocket.toString());
            }
            catch(IOException e){
                                // Something went wrong with the ServerSocket, so we'll stop listening
                run=false;
            }
                        // If we've stopped on the line above we won't want to try this !
            if(run){
                                try {
                                    // Setup the TCPReaderInit and start it
                    TCPReaderInit init = new TCPReaderInit(hostSocket, _queue);
                                    // and start it
                    init.start();
                } catch (IOException e) {
                    _logger.write(toString(), Logger.ERROR, e.toString());
                }
            }
        }
                // Best log the fact that we're stopping
        _logger.write(toString(), Logger.FATAL, "Fatal error, shutdown pending");
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.NameFormat class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---
    
    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = FilterMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();
    
    /**
         * The port on which the server should listen.
         */
    private int _port;
    
    /**
     * A reference to our Queue
     */
    private Queue _queue;
    
//---STATIC ATTRIBUTES---

}
Revision:	1.8
Committed:	Sun Jan 28 05:34:38 2001 UTC (23 years, 3 months ago) by tdb
Branch:	MAIN
Changes since 1.7:	+10 -10 lines
Log Message:	Some tidying up.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2	tdb	1.2	package uk.ac.ukc.iscream.filter;
3	tdb	1.1
4			//---IMPORTS---
5			import uk.ac.ukc.iscream.core.*;
6	tdb	1.7	import uk.ac.ukc.iscream.componentmanager.*;
7	tdb	1.1	import uk.ac.ukc.iscream.filter.*;
8			import java.net.Socket;
9			import java.net.ServerSocket;
10			import java.io.OutputStream;
11			import java.io.IOException;
12			import java.net.InetAddress;
13			import java.net.UnknownHostException;
14	ajm	1.4	import uk.ac.ukc.iscream.util.*;
15	tdb	1.1
16			/**
17	tdb	1.8	* Reads TCP Heartbeats from the host applications.
18	tdb	1.1	*
19	tdb	1.7	* @author $Author: tdb1 $
20	tdb	1.8	* @version $Id: TCPReader.java,v 1.7 2001/01/18 23:15:50 tdb1 Exp $
21	tdb	1.1	*/
22			class TCPReader extends Thread {
23
24			//---FINAL ATTRIBUTES---
25
26			/**
27			* The current CVS revision of this class
28			*/
29	tdb	1.8	public final String REVISION = "$Revision: 1.7 $";
30	tdb	1.1
31			//---STATIC METHODS---
32
33			//---CONSTRUCTORS---
34
35			/**
36	tdb	1.8	* Constructs a new TCPReader
37	tdb	1.1	*
38	tdb	1.8	* @param queue A reference to our Queue
39			* @param port The port that the TCPReader will listen on
40	tdb	1.1	*/
41	tdb	1.6	public TCPReader(int port, Queue queue) {
42	tdb	1.1	_port = port;
43	tdb	1.6	_queue = queue;
44	tdb	1.1	_logger.write(toString(), Logger.SYSINIT, "started");
45			}
46
47
48
49			//---PUBLIC METHODS---
50
51			/**
52			* The run() method is the main loop for this thread, and we
53			* will remain in here until such a point as something goes
54			* wrong with the listening. After initially setting up the
55			* ServerSocket we go round a while loop receiving connections
56			* and then passing them off to other processes to deal with.
57			*/
58			public void run(){
59			ServerSocket listenPort=null;
60			// We use this boolean so we can break out of the while loop if we want
61			boolean run = true;
62			try{
63			// Setup the ServerSocket so that clients can connect
64			listenPort = new ServerSocket(_port);
65			}
66			catch(IOException e){
67			}
68			// Log what machine/port we're listening on
69			try{
70			_logger.write(toString(), Logger.SYSMSG, "TCPReader listening on "
71			+InetAddress.getLocalHost().getHostName()
72			+"/"+InetAddress.getLocalHost().getHostAddress()
73			+" port "+listenPort.getLocalPort());
74			}
75			catch(UnknownHostException e){
76			_logger.write(toString(), Logger.SYSMSG, "TCPReader listening on UnknownHost "
77			+"port "+listenPort.getLocalPort());
78			}
79			// Loop round constantly until we decide to stop
80			while(run){
81			Socket hostSocket=null;
82			try{
83			_logger.write(toString(), Logger.SYSMSG, "Waiting for Connection");
84			// This will block until a host connects - at which point we get a Socket
85			hostSocket = listenPort.accept();
86			_logger.write(toString(), Logger.SYSMSG, "Connection accepted from: " + hostSocket.toString());
87			}
88			catch(IOException e){
89			// Something went wrong with the ServerSocket, so we'll stop listening
90			run=false;
91			}
92			// If we've stopped on the line above we won't want to try this !
93			if(run){
94			try {
95	tdb	1.8	// Setup the TCPReaderInit and start it
96	tdb	1.6	TCPReaderInit init = new TCPReaderInit(hostSocket, _queue);
97	tdb	1.1	// and start it
98			init.start();
99			} catch (IOException e) {
100			_logger.write(toString(), Logger.ERROR, e.toString());
101			}
102			}
103			}
104			// Best log the fact that we're stopping
105			_logger.write(toString(), Logger.FATAL, "Fatal error, shutdown pending");
106			}
107
108			/**
109			* Overrides the {@link java.lang.Object#toString() Object.toString()}
110			* method to provide clean logging (every class should have this).
111			*
112	ajm	1.5	* This uses the uk.ac.ukc.iscream.util.NameFormat class
113			* to format the toString()
114			*
115	tdb	1.1	* @return the name of this class and its CVS revision
116			*/
117			public String toString() {
118	ajm	1.5	return FormatName.getName(
119			_name,
120			getClass().getName(),
121			REVISION);
122	tdb	1.1	}
123
124			//---PRIVATE METHODS---
125
126			//---ACCESSOR/MUTATOR METHODS---
127
128			//---ATTRIBUTES---
129
130			/**
131	ajm	1.5	* This is the friendly identifier of the
132			* component this class is running in.
133			* eg, a Filter may be called "filter1",
134			* If this class does not have an owning
135			* component, a name from the configuration
136			* can be placed here. This name could also
137			* be changed to null for utility classes.
138			*/
139			private String _name = FilterMain.NAME;
140
141			/**
142			* This holds a reference to the
143			* system logger that is being used.
144	tdb	1.1	*/
145	ajm	1.5	private Logger _logger = ReferenceManager.getInstance().getLogger();
146	tdb	1.1
147			/**
148			* The port on which the server should listen.
149			*/
150			private int _port;
151
152	tdb	1.8	/**
153			* A reference to our Queue
154			*/
155	tdb	1.6	private Queue _queue;
156	tdb	1.1
157			//---STATIC ATTRIBUTES---
158
159			}