KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xsocket > datagram > IDatagramHandler


1 // $Id: IDatagramHandler.java 1049 2007-03-21 16:42:48Z grro $
2 /*
3  * Copyright (c) xsocket.org, 2006 - 2007. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library 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 GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
20  * The latest copy of this software may be found on http://www.xsocket.org/
21  */
22 package org.xsocket.datagram;
23
24 import java.io.IOException JavaDoc;
25
26
27
28
29 /**
30  * Endpoint handler, which will be used by receiving a datagram in a asynchronous manner. E.g.
31  *
32  * <pre>
33  * class MyHandler implements IDatagramHandler {
34  *
35  * public boolean onDatagram(IEndpoint localEndpoint) throws IOException {
36  * UserDatagram datagram = localEndpoint.receive(); // get the datagram
37  * ...
38  * return true; // true -> signal that this event has been handled
39  * }
40  * }
41  * </pre>
42  *
43  * @author grro@xsocket.org
44  */
45 public interface IDatagramHandler {
46     
47     
48     /**
49      * signals a incoming datagram
50      *
51      * @param localEndpoint the local endpoint
52      * @return true if the event has been handled
53      * @throws IOException If some other I/O error occurs
54      */
55     public boolean onDatagram(IEndpoint localEndpoint) throws IOException JavaDoc;
56 }
Popular Tags