View Javadoc

    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  /**
    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  public interface WriteCompletionEvent extends ChannelEvent {
    26      /**
    27       * Returns the amount of data written.
    28       *
    29       * @return the number of written bytes or messages, depending on the
    30       *         type of the transport
    31       */
    32      long getWrittenAmount();
    33  }