View Javadoc

    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  /**
    19   * A {@link ChannelEvent} which represents the notification of the completion
    20   * of a write request on a {@link Channel}.  This event is for going upstream
    21   * only.  Please refer to the {@link ChannelEvent} documentation to find out
    22   * what an upstream event and a downstream event are and what fundamental
    23   * differences they have.
    24   *
    25   * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
    26   * @author <a href="http://gleamynode.net/">Trustin Lee</a>
    27   *
    28   * @version $Rev: 2202 $, $Date: 2010-02-23 16:18:58 +0900 (Tue, 23 Feb 2010) $
    29   */
    30  public interface WriteCompletionEvent extends ChannelEvent {
    31      /**
    32       * Returns the amount of data written.
    33       *
    34       * @return the number of written bytes or messages, depending on the
    35       *         type of the transport
    36       */
    37      long getWrittenAmount();
    38  }