KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > mina > common > BroadcastIoSession


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  *
19  */

20 package org.apache.mina.common;
21
22 import java.net.SocketAddress JavaDoc;
23
24 /**
25  * An {@link IoSession} for broadcast transports. (e.g. UDP broadcast or multicast)
26  *
27  * <h2>Writing Back to the Broadcasting Server</h2>
28  * <p>
29  * When you implement a client that receives a broadcast message from a server
30  * such as DHCP server, the client might need to send a response message for the
31  * broadcast message the server sent. Because the remote address of the session
32  * is not the address of the server in case of broadcasting, there should be a
33  * way to specify the destination when you write the response message.
34  * This interface provides {@link #write(Object, SocketAddress)} method so you
35  * can specify the destination.
36  * </p>
37  *
38  * @author The Apache Directory Project (mina-dev@directory.apache.org)
39  * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (금, 13 7월 2007) $
40  */

41 public interface BroadcastIoSession extends IoSession {
42     /**
43      * Writes the specified <tt>message</tt> to the specified <tt>destination</tt>.
44      * This operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}
45      * will be invoked when the message is actually sent to remote peer. You can
46      * also wait for the returned {@link WriteFuture} if you want to wait for
47      * the message actually written.
48      *
49      * @param destination <tt>null</tt> if you want the message sent to the
50      * default remote address
51      */

52     WriteFuture write(Object JavaDoc message, SocketAddress JavaDoc destination);
53 }
54
Popular Tags