Constructor Detail

• AbstractInputSocket

  public AbstractInputSocket()

Method Detail

• channel

  public SeekableByteChannel channel(OutputSocket<? extends Entry> peer)
                              throws IOException

  Optional operation: Returns a new seekable byte channel for reading bytes. If this operation is supported, then the returned seekable byte channel should not be buffered. Buffering should get addressed by the caller instead.

  Because the intention of this interface is input, the returned channel may not be able to write data and any attempt to do so should fail with a NonWritableChannelException.

  Specified by:

  channel in interface InputSocket<E extends Entry>

  Parameters:

  peer - the nullable peer socket for copying entry contents.

  Returns:

  A new seekable byte channel for reading bytes.

  Throws:

  UnsupportedOperationException - the implementation in the class InputSocket always throws an exception of this type.

  IOException - on any I/O error.

• stream

  public InputStream stream(OutputSocket<? extends Entry> peer)
                     throws IOException

  Returns a new input stream for reading bytes. The returned input stream should not be buffered. Buffering should get addressed by the caller instead.

  The implementation in the class InputSocket calls channel(net.java.truecommons.cio.OutputSocket<? extends net.java.truecommons.cio.Entry>) and wraps the result in a ChannelInputStream adapter. Note that this violates the contract for this method unless you override either this method or channel(net.java.truecommons.cio.OutputSocket<? extends net.java.truecommons.cio.Entry>) with a valid implementation.

  Specified by:

  stream in interface InputSocket<E extends Entry>

  Parameters:

  peer - the nullable peer socket for copying entry contents.

  Returns:

  A new input stream for reading bytes.

  Throws:

  IOException - on any I/O error.

• target

  @Nullable
  protected static <E extends Entry> E target(@Nullable
                                    OutputSocket<E> peer)
                                   throws IOException

  Returns the target of the given nullable peer socket or null. This method is provided for convenience.

  Type Parameters:

  E - the type of the peer socket's local target.

  Parameters:

  peer - the nullable peer socket.

  Returns:

  null if the given reference is null or the target of the given peer socket otherwise.

  Throws:

  IOException - if resolving the peer's local target fails.