org.xnio.channels.ConnectedChannel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xnio-api

The API JAR of the XNIO project

There is a newer version: 3.8.16.Final

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2008, JBoss Inc., and individual contributors as indicated
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.xnio.channels;

import java.net.SocketAddress;
import org.xnio.ChannelListener;

/**
 * A channel that has a local and peer endpoint address.
 */
public interface ConnectedChannel extends BoundChannel {
    /**
     * Get the peer address of this channel.
     *
     * @return the peer address
     */
    SocketAddress getPeerAddress();

    /**
     * Get the peer address of a given type, or {@code null} if the address is not of that
     * type.
     *
     * @param type the address type class
     * @return the peer address, or {@code null} if unknown
     */
     A getPeerAddress(Class type);

    /** {@inheritDoc} */
    ChannelListener.Setter getCloseSetter();
}