1 /*
2 * Copyright 2012 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the 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 * @apiviz.has org.jboss.netty.channel.ChannelPipeline oneway - - creates
36 */
37 public interface ChannelPipelineFactory {
38
39 /**
40 * Returns a newly created {@link ChannelPipeline}.
41 */
42 ChannelPipeline getPipeline() throws Exception;
43 }