1 /*
2 * Copyright 2009 Red Hat, Inc.
3 *
4 * Red Hat licenses this file to you under the Apache License, version 2.0
5 * (the "License"); you may not use this file except in compliance with the
6 * License. You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package org.jboss.netty.channel;
17
18 import org.jboss.netty.bootstrap.Bootstrap;
19 import org.jboss.netty.bootstrap.ClientBootstrap;
20 import org.jboss.netty.bootstrap.ConnectionlessBootstrap;
21
22 /**
23 * Creates a new {@link ChannelPipeline} for a new {@link Channel}.
24 * <p>
25 * When a {@linkplain ServerChannel server-side channel} accepts a new incoming
26 * connection, a new child channel is created for each newly accepted connection.
27 * A new child channel uses a new {@link ChannelPipeline}, which is created by
28 * the {@link ChannelPipelineFactory} specified in the server-side channel's
29 * {@link ChannelConfig#getPipelineFactory() "pipelineFactory"} option.
30 * <p>
31 * Also, when a {@link ClientBootstrap} or {@link ConnectionlessBootstrap}
32 * creates a new channel, it uses the {@link Bootstrap#getPipelineFactory() "pipelineFactory"}
33 * property to create a new {@link ChannelPipeline} for each new channel.
34 *
35 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
36 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
37 *
38 * @version $Rev: 2145 $, $Date: 2010-02-09 12:56:29 +0900 (Tue, 09 Feb 2010) $
39 *
40 * @apiviz.has org.jboss.netty.channel.ChannelPipeline oneway - - creates
41 */
42 public interface ChannelPipelineFactory {
43
44 /**
45 * Returns a newly created {@link ChannelPipeline}.
46 */
47 ChannelPipeline getPipeline() throws Exception;
48 }