View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.filter.executor;
21  
22  import org.apache.mina.core.session.IoEvent;
23  
24  /**
25   * Estimates the amount of memory that the specified {@link IoEvent} occupies
26   * in the current JVM.
27   * 
28   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
29   */
30  public interface IoEventSizeEstimator {
31      /**
32       * Estimate the IoEvent size in number of bytes
33       * @param event The event we want to estimate the size of
34       * @return The estimated size of this event
35       */
36      int estimateSize(IoEvent event);
37  }