View Javadoc
1   /*
2    * Copyright 2015 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 io.netty.channel.pool;
17  
18  import io.netty.channel.Channel;
19  import io.netty.channel.EventLoop;
20  import io.netty.util.concurrent.Promise;
21  
22  /**
23   * Handler which is called for various actions done by the {@link ChannelPool}.
24   */
25  public interface ChannelPoolHandler {
26      /**
27       * Called once a {@link Channel} was released by calling {@link ChannelPool#release(Channel)} or
28       * {@link ChannelPool#release(Channel, Promise)}.
29       *
30       * This method will be called by the {@link EventLoop} of the {@link Channel}.
31       */
32      void channelReleased(Channel ch) throws Exception;
33  
34      /**
35       * Called once a {@link Channel} was acquired by calling {@link ChannelPool#acquire()} or
36       * {@link ChannelPool#acquire(Promise)}.
37       *
38       * This method will be called by the {@link EventLoop} of the {@link Channel}.
39       */
40      void channelAcquired(Channel ch) throws Exception;
41  
42      /**
43       * Called once a new {@link Channel} is created in the {@link ChannelPool}.
44       *
45       * This method will be called by the {@link EventLoop} of the {@link Channel}.
46       */
47      void channelCreated(Channel ch) throws Exception;
48  }