summaryrefslogtreecommitdiffstats
path: root/libraries/oscP5/src/netP5/AbstractUdpServer.java
blob: 9a35d630fd1316e9ef7a6eb179de7f444a597232 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/**
 * A network library for processing which supports UDP, TCP and Multicast.
 *
 * (c) 2004-2012
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA  02111-1307  USA
 * 
 * @author		Andreas Schlegel http://www.sojamo.de
 * @modified	12/23/2012
 * @version		0.9.9
 */

package netP5;

import java.io.IOException;
import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.UnknownHostException;


public abstract class AbstractUdpServer implements Runnable {

	private DatagramSocket _myDatagramSocket = null;

	protected UdpPacketListener _myListener;

	private Thread _myThread = null;

	private int _myPort;

	private String _myAddress;

	private InetAddress _myInetAddress;

	protected int _myDatagramSize = 1536; // common MTU

	private boolean isRunning = true;

	private boolean isSocket = false;

	/**
	 * create a new UdpServer
	 * 
	 * @invisible
	 * @param theListener
	 *            UdpPacketListener
	 * @param thePort
	 *            int
	 * @param theBufferSize
	 *            int
	 */
	public AbstractUdpServer(UdpPacketListener theListener, int thePort,
			int theBufferSize) {
		_myDatagramSize = theBufferSize;
		_myPort = thePort;
		_myListener = theListener;
		if (_myListener != null) {
			start();
		}
	}

	/**
	 * @invisible
	 * @param theListener
	 *            UdpPacketListener
	 * @param theAddress
	 *            String
	 * @param thePort
	 *            int
	 * @param theBufferSize
	 *            int
	 */
	protected AbstractUdpServer(UdpPacketListener theListener,
			String theAddress, int thePort, int theBufferSize) {
		_myDatagramSize = theBufferSize;
		_myAddress = theAddress;
		_myPort = thePort;
		_myListener = theListener;
		if (_myListener != null) {
			start();
		}
	}

	/**
	 * get the datagram socket of the UDP server.
	 * 
	 * @return DatagramSocket
	 */
	public DatagramSocket socket() {
		return _myDatagramSocket;
	}

	/**
	 * @invisible
	 * 
	 */
	public void start() {
		_myThread = null;
		_myDatagramSocket = null;
		_myThread = new Thread(this);
		try {
			Thread.sleep(1000);
		} catch (InterruptedException iex) {
			Logger.printError("UdpServer.start()",
					"oscServer sleep interruption " + iex);
		}
		try {
			_myDatagramSocket = new DatagramSocket(_myPort);
			_myInetAddress = InetAddress.getByName(_myAddress);
			Logger.printProcess("UdpServer.start()",
					"new Unicast DatagramSocket created @ port " + _myPort);
		} catch (IOException ioex) {
			Logger.printError("UdpServer.start()",
					" IOException, couldnt create new DatagramSocket @ port "
							+ _myPort + " " + ioex);
		}

		if (_myDatagramSocket != null) {
			_myThread.start();
			isRunning = _myThread.isAlive();
			isSocket = true;
		} else {
			isRunning = false;
		}
	}

	/**
	 * @invisible
	 */
	public void run() {
		if (_myDatagramSocket != null) {
			if (isRunning) {
				Logger.printProcess("UdpServer.run()",
						"UdpServer is running @ " + _myPort);
			}
		} else {
			Logger.printError("UdpServer.run()",
					"Socket is null. closing UdpServer.");
			return;
		}

		while (isRunning) {
			try {
				byte[] myBuffer = new byte[_myDatagramSize];
				DatagramPacket myPacket = new DatagramPacket(myBuffer,
						_myDatagramSize);
				_myDatagramSocket.receive(myPacket);
				_myListener.process(myPacket, _myPort);
			} catch (IOException ioex) {
				Logger.printProcess("UdpServer.run()", " socket closed.");
				break;
			} catch (ArrayIndexOutOfBoundsException ex) {
				Logger.printError("UdpServer.run()",
						"ArrayIndexOutOfBoundsException:  " + ex);
			}
		}
		dispose();
	}

	/**
	 * stop the UDP server, clean up and delete its reference.
	 */
	public void dispose() {
		isRunning = false;
		_myThread = null;
		if (_myDatagramSocket != null) {
			if (_myDatagramSocket.isConnected()) {
				Logger.printDebug("UdpServer.dispose()", "disconnect()");
				_myDatagramSocket.disconnect();
			}
			Logger.printDebug("UdpServer.dispose()", "close()");
			_myDatagramSocket.close();
			_myDatagramSocket = null;
			Logger.printDebug("UdpServer.dispose()",
					"Closing unicast datagram socket.");
		}
	}

	/**
	 * send a byte array to a previously defined remoteAddress.
	 * 
	 * @param theBytes
	 *            byte[]
	 */
	public void send(byte[] theBytes) {
		if (isSocket) {
			send(theBytes, _myInetAddress, _myPort);
		} else {
			Logger
					.printWarning("UdpClient.send",
							"no InetAddress and port has been set. Packet has not been sent.");
		}
	}

	/**
	 * send a byte array to a dedicated remoteAddress.
	 * 
	 * @param thePacket
	 *            OscPacket
	 * @param theAddress
	 *            String
	 * @param thePort
	 *            int
	 */
	public void send(byte[] theBytes, String theAddress, int thePort) {
		try {
			InetAddress myInetAddress = InetAddress.getByName(theAddress);
			send(theBytes, myInetAddress, thePort);
		} catch (UnknownHostException e) {
			Logger.printError("UdpClient.send", "while sending to "
					+ theAddress + " " + e);
		}
	}

	/**
	 * @invisible
	 * @param thePacket
	 *            DatagramPacket
	 */
	public void send(DatagramPacket thePacket) {
		if (isSocket) {
			try {
				_myDatagramSocket.send(thePacket);
			} catch (IOException e) {
				Logger.printError("UdpClient.send",
						"ioexception while sending packet.");
			}
		}
	}

	/**
	 * send a byte array to a dedicated remoteAddress.
	 * 
	 * @param theBytes
	 *            byte[]
	 * @param theAddress
	 *            InetAddress
	 * @param thePort
	 *            int
	 */
	public void send(byte[] theBytes, InetAddress theAddress, int thePort) {
		if (isSocket) {
			try {
				DatagramPacket myPacket = new DatagramPacket(theBytes,
						theBytes.length, theAddress, thePort);
				send(myPacket);
			} catch (NullPointerException npe) {
				Logger.printError("UdpServer.send",
						"a nullpointer exception occured." + npe);
			}
		} else {
			Logger.printWarning("UdpServer.send",
					"DatagramSocket is not running. Packet has not been sent.");
		}
	}

}