org.littleshoot.mina.common.BroadcastIoSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mina-port Show documentation
There is a newer version: 1.4
/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.littleshoot.mina.common;

import java.net.SocketAddress;

/**
 * An {@link IoSession} for broadcast transports. (e.g. UDP broadcast or multicast)
 * 
 * Writing Back to the Broadcasting Server
 * 
 * When you implement a client that receives a broadcast message from a server
 * such as DHCP server, the client might need to send a response message for the
 * broadcast message the server sent.  Because the remote address of the session
 * is not the address of the server in case of broadcasting, there should be a
 * way to specify the destination when you write the response message.
 * This interface provides {@link #write(Object, SocketAddress)} method so you
 * can specify the destination.
 * 
 * 
 * @author The Apache Directory Project ([email protected])
 * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
 */
public interface BroadcastIoSession extends IoSession {
    /**
     * Writes the specified message to the specified destination.
     * This operation is asynchronous; {@link IoHandler#messageSent(IoSession, Object)}
     * will be invoked when the message is actually sent to remote peer. You can
     * also wait for the returned {@link WriteFuture} if you want to wait for
     * the message actually written.
     * 
     * @param destination null if you want the message sent to the
     *                    default remote address
     */
    WriteFuture write(Object message, SocketAddress destination);
}