Module 
Package org.xnio

Class Connection

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Connection​(XnioIoThread thread)
      Construct a new instance.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close this channel.
      protected void closeAction()
      The close action to perform on this connection.
      XnioIoThread getIoThread()
      Get the I/O thread associated with this channel.
      <A extends java.net.SocketAddress>
      A      		 getLocalAddress​(java.lang.Class<A> type)
      Get the local address of a given type, or null if the address is not of that type.
      <T> T getOption​(Option<T> option)
      Get the value of a channel option.
      <A extends java.net.SocketAddress>
      A      		 getPeerAddress​(java.lang.Class<A> type)
      Get the peer address of a given type, or null if the address is not of that type.
      XnioWorker getWorker()
      Get the worker for this channel.
      boolean isOpen()  
      boolean isReadShutdown()
      Determine whether reads have been shut down on this connection.
      boolean isWriteShutdown()
      Determine whether writes have been shut down on this connection.
      protected abstract void notifyReadClosed()
      Indicate to conduit handlers that reads have been closed.
      protected abstract void notifyWriteClosed()
      Indicate to conduit handlers that writes have been closed.
      protected boolean readClosed()
      Indicate that reads have been closed on this connection.
      <T> T setOption​(Option<T> option, T value)
      Set an option for this channel.
      boolean supportsOption​(Option<?> option)
      Determine whether an option is supported on this channel.
      protected boolean writeClosed()
      Indicate that writes have been closed on this connection.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Connection

        protected Connection​(XnioIoThread thread)
        Construct a new instance.
        Parameters:
        thread - the I/O thread of this connection

    • Method Detail

      • getPeerAddress

        public final <A extends java.net.SocketAddress> A getPeerAddress​(java.lang.Class<A> type)
        Description copied from interface: ConnectedChannel
        Get the peer address of a given type, or null if the address is not of that type.
        Specified by:
        getPeerAddress in interface ConnectedChannel
        Parameters:
        type - the address type class
        Returns:
        the peer address, or null if unknown

      • getLocalAddress

        public final <A extends java.net.SocketAddress> A getLocalAddress​(java.lang.Class<A> type)
        Description copied from interface: BoundChannel
        Get the local address of a given type, or null if the address is not of that type.
        Specified by:
        getLocalAddress in interface BoundChannel
        Type Parameters:
        A - the address type
        Parameters:
        type - the address type class
        Returns:
        the local address, or null if unknown

      • readClosed

        protected boolean readClosed()
        Indicate that reads have been closed on this connection.
        Returns:
        true if read closure was successfully indicated; false if this method has already been called

      • writeClosed

        protected boolean writeClosed()
        Indicate that writes have been closed on this connection.
        Returns:
        true if write closure was successfully indicated; false if this method has already been called

      • close

        public final void close()
                 throws java.io.IOException
        Description copied from interface: CloseableChannel
        Close this channel. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.nio.channels.Channel
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface CloseableChannel
        Specified by:
        close in interface java.nio.channels.InterruptibleChannel
        Throws:
        java.io.IOException - if the close failed

      • isReadShutdown

        public boolean isReadShutdown()
        Determine whether reads have been shut down on this connection.
        Returns:
        true if reads were shut down

      • isWriteShutdown

        public boolean isWriteShutdown()
        Determine whether writes have been shut down on this connection.
        Returns:
        true if writes were shut down

      • isOpen

        public boolean isOpen()
        Specified by:
        isOpen in interface java.nio.channels.Channel

      • notifyWriteClosed

        protected abstract void notifyWriteClosed()
        Indicate to conduit handlers that writes have been closed.

      • notifyReadClosed

        protected abstract void notifyReadClosed()
        Indicate to conduit handlers that reads have been closed.

      • closeAction

        protected void closeAction()
                    throws java.io.IOException
        The close action to perform on this connection.
        Throws:
        java.io.IOException - if close fails

      • supportsOption

        public boolean supportsOption​(Option<?> option)
        Description copied from interface: Configurable
        Determine whether an option is supported on this channel.
        Specified by:
        supportsOption in interface Configurable
        Parameters:
        option - the option
        Returns:
        true if it is supported

      • getOption

        public <T> T getOption​(Option<T> option)
                throws java.io.IOException
        Description copied from interface: Configurable
        Get the value of a channel option.
        Specified by:
        getOption in interface Configurable
        Type Parameters:
        T - the type of the option value
        Parameters:
        option - the option to get
        Returns:
        the value of the option, or null if it is not set
        Throws:
        java.io.IOException - if an I/O error occurred when reading the option

      • setOption

        public <T> T setOption​(Option<T> option,
                       T value)
                throws java.lang.IllegalArgumentException,
                       java.io.IOException
        Description copied from interface: Configurable
        Set an option for this channel. Unsupported options are ignored.
        Specified by:
        setOption in interface Configurable
        Type Parameters:
        T - the type of the option value
        Parameters:
        option - the option to set
        value - the value of the option to set
        Returns:
        the previous option value, if any
        Throws:
        java.lang.IllegalArgumentException - if the value is not acceptable for this option
        java.io.IOException - if an I/O error occurred when modifying the option