2008-08-08 02:37:18 +02:00
|
|
|
/*
|
2008-08-08 03:27:24 +02:00
|
|
|
* JBoss, Home of Professional Open Source
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
|
|
|
|
* by the @author tags. See the COPYRIGHT.txt in the distribution for a
|
|
|
|
* full listing of individual contributors.
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* This 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 software is distributed in the hope that it will be useful,
|
2008-08-08 02:37:18 +02:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2008-08-08 03:27:24 +02:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
2008-08-08 02:37:18 +02:00
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2008-08-08 03:27:24 +02:00
|
|
|
* License along with this software; if not, write to the Free
|
|
|
|
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
|
|
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
|
2008-08-08 02:37:18 +02:00
|
|
|
*/
|
2008-08-08 03:40:10 +02:00
|
|
|
package org.jboss.netty.channel;
|
2008-08-08 02:37:18 +02:00
|
|
|
|
2008-09-02 09:13:20 +02:00
|
|
|
import java.io.IOException;
|
2008-08-08 02:37:18 +02:00
|
|
|
import java.util.Map;
|
|
|
|
|
2008-09-03 03:30:17 +02:00
|
|
|
import org.jboss.netty.channel.socket.SocketChannelConfig;
|
2008-09-24 13:28:46 +02:00
|
|
|
import org.jboss.netty.channel.socket.nio.NioSocketChannelConfig;
|
2008-09-02 14:04:04 +02:00
|
|
|
|
2008-08-08 02:37:18 +02:00
|
|
|
|
|
|
|
/**
|
2008-09-02 15:45:14 +02:00
|
|
|
* A set of configuration properties of a {@link Channel}.
|
2008-09-02 09:13:20 +02:00
|
|
|
* <p>
|
2008-09-03 03:30:17 +02:00
|
|
|
* Please down-cast to more specific configuration type such as
|
|
|
|
* {@link SocketChannelConfig} or use {@link #setOptions(Map)} to set the
|
2008-09-02 15:45:14 +02:00
|
|
|
* transport-specific properties:
|
|
|
|
* <pre>
|
|
|
|
* Channel ch = ...;
|
2008-09-03 03:30:17 +02:00
|
|
|
* SocketChannelConfig cfg = <strong>(SocketChannelConfig) ch.getConfig();</strong>
|
|
|
|
* cfg.setTcpNoDelay(false);
|
2008-09-02 15:45:14 +02:00
|
|
|
* </pre>
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-09-24 13:28:46 +02:00
|
|
|
* <h3>Option map</h3>
|
|
|
|
*
|
|
|
|
* An option map property is a dynamic write-only property which allows
|
|
|
|
* the configuration of a {@link Channel} without down-casting its associated
|
|
|
|
* {@link ChannelConfig}. To update an option map, please call {@link #setOptions(Map)}.
|
|
|
|
* <p>
|
|
|
|
* All {@link ChannelConfig} has the following options:
|
|
|
|
* <table>
|
|
|
|
* <tr>
|
|
|
|
* <th>Name</th><th>Associated setter method</th>
|
|
|
|
* </tr><tr>
|
|
|
|
* <td>{@code "connectTimeoutMillis"}</td><td>{@link #setConnectTimeoutMillis(int)}</td>
|
|
|
|
* </tr><tr>
|
|
|
|
* <td>{@code "writeTimeoutMillis"}</td><td>{@link #setWriteTimeoutMillis(int)}</td>
|
|
|
|
* </tr><tr>
|
|
|
|
* <td>{@code "pipelineFactory"}</td><td>{@link #setPipelineFactory(ChannelPipelineFactory)}</td>
|
|
|
|
* </tr>
|
|
|
|
* </table>
|
|
|
|
*
|
|
|
|
* More options are available in the sub-types of {@link ChannelConfig}. For
|
|
|
|
* example, you can configure the parameters which are specific to a TCP/IP
|
|
|
|
* socket as explained in {@link SocketChannelConfig} or {@link NioSocketChannelConfig}.
|
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* @author The Netty Project (netty-dev@lists.jboss.org)
|
|
|
|
* @author Trustin Lee (tlee@redhat.com)
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
|
|
|
* @version $Rev$, $Date$
|
|
|
|
*
|
2008-08-08 03:40:10 +02:00
|
|
|
* @apiviz.has org.jboss.netty.channel.ChannelPipelineFactory
|
2008-08-08 02:37:18 +02:00
|
|
|
*/
|
|
|
|
public interface ChannelConfig {
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the configuration properties from the specified {@link Map}.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
void setOptions(Map<String, Object> options);
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the {@link ChannelPipelineFactory} which will be used when
|
2008-09-02 14:04:04 +02:00
|
|
|
* a child channel is created. If the {@link Channel} doesn't create
|
|
|
|
* a child channel, this property is not used at all, and therefore will
|
|
|
|
* be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
ChannelPipelineFactory getPipelineFactory();
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the {@link ChannelPipelineFactory} which will be used when
|
2008-09-02 14:04:04 +02:00
|
|
|
* a child channel is created. If the {@link Channel} doesn't create
|
|
|
|
* a child channel, this property is not used at all, and therefore will
|
|
|
|
* be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
void setPipelineFactory(ChannelPipelineFactory pipelineFactory);
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
2008-09-02 14:04:04 +02:00
|
|
|
* Returns the connect timeout of the channel in milliseconds. If the
|
|
|
|
* {@link Channel} doesn't support connect operation, this property is not
|
|
|
|
* used at all, and therefore will be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*
|
|
|
|
* @return the connect timeout in milliseconds. {@code 0} if disabled.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
int getConnectTimeoutMillis();
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
2008-09-02 14:04:04 +02:00
|
|
|
* Sets the connect timeout of the channel in milliseconds. If the
|
|
|
|
* {@link Channel} doesn't support connect operation, this property is not
|
|
|
|
* used at all, and therefore will be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*
|
|
|
|
* @param connectTimeoutMillis the connect timeout in milliseconds.
|
|
|
|
* {@code 0} to disable.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
void setConnectTimeoutMillis(int connectTimeoutMillis);
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the write timeout of the channel in milliseconds. If a write
|
2008-09-24 11:48:32 +02:00
|
|
|
* operation is not completed within the write timeout, an
|
|
|
|
* {@link IOException} will be raised. If the {@link Channel} doesn't
|
|
|
|
* support write operation, this property is not used at all, and therefore
|
|
|
|
* will be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*
|
|
|
|
* @return the write timeout in milliseconds. {@code 0} if disabled.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
int getWriteTimeoutMillis();
|
2008-09-02 09:13:20 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the write timeout of the channel in milliseconds. If a write
|
2008-09-24 11:48:32 +02:00
|
|
|
* operation is not completed within the write timeout, an
|
|
|
|
* {@link IOException} will be raised. If the {@link Channel} doesn't
|
|
|
|
* support write operation, this property is not used at all, and therefore
|
|
|
|
* will be ignored.
|
2008-09-02 09:13:20 +02:00
|
|
|
*
|
|
|
|
* @param writeTimeoutMillis the write timeout in milliseconds.
|
|
|
|
* {@code 0} to disable.
|
|
|
|
*/
|
2008-08-08 02:37:18 +02:00
|
|
|
void setWriteTimeoutMillis(int writeTimeoutMillis);
|
|
|
|
}
|