001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.filter.executor;
021
022import org.apache.mina.core.session.IoEvent;
023
024/**
025 * Estimates the amount of memory that the specified {@link IoEvent} occupies
026 * in the current JVM.
027 * 
028 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
029 */
030public interface IoEventSizeEstimator {
031    /**
032     * Estimate the IoEvent size in number of bytes
033     * @param event The event we want to estimate the size of
034     * @return The estimated size of this event
035     */
036    int estimateSize(IoEvent event);
037}