/*
 * Copyright 2016 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.netty.channel.socket;

import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelPromise;

import java.net.Socket;

A duplex Channel that has two sides that can be shutdown independently. /**
 * A duplex {@link Channel} that has two sides that can be shutdown independently.
 */
public interface DuplexChannel extends Channel {
    
Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown(). /**
     * Returns {@code true} if and only if the remote peer shut down its output so that no more
     * data is received from this channel.  Note that the semantic of this method is different from
     * that of {@link Socket#shutdownInput()} and {@link Socket#isInputShutdown()}.
     */
    boolean isInputShutdown();

    
See Also:
shutdownInput.shutdownInput()/**
     * @see Socket#shutdownInput()
     */
    ChannelFuture shutdownInput();

    
Will shutdown the input and notify ChannelPromise. 
See Also:
Socket.shutdownInput()/**
     * Will shutdown the input and notify {@link ChannelPromise}.
     *
     * @see Socket#shutdownInput()
     */
    ChannelFuture shutdownInput(ChannelPromise promise);

    
See Also:
isOutputShutdown.isOutputShutdown()/**
     * @see Socket#isOutputShutdown()
     */
    boolean isOutputShutdown();

    
See Also:
shutdownOutput.shutdownOutput()/**
     * @see Socket#shutdownOutput()
     */
    ChannelFuture shutdownOutput();

    
Will shutdown the output and notify ChannelPromise. 
See Also:
Socket.shutdownOutput()/**
     * Will shutdown the output and notify {@link ChannelPromise}.
     *
     * @see Socket#shutdownOutput()
     */
    ChannelFuture shutdownOutput(ChannelPromise promise);

    
Determine if both the input and output of this channel have been shutdown.
/**
     * Determine if both the input and output of this channel have been shutdown.
     */
    boolean isShutdown();

    
Will shutdown the input and output sides of this channel.
Returns:
will be completed when both shutdown operations complete./**
     * Will shutdown the input and output sides of this channel.
     * @return will be completed when both shutdown operations complete.
     */
    ChannelFuture shutdown();

    
Will shutdown the input and output sides of this channel.
Params:
promise – will be completed when both shutdown operations complete.
Returns:
will be completed when both shutdown operations complete./**
     * Will shutdown the input and output sides of this channel.
     * @param promise will be completed when both shutdown operations complete.
     * @return will be completed when both shutdown operations complete.
     */
    ChannelFuture shutdown(ChannelPromise promise);
}