Module jcifs
Package org.codelibs.jcifs.smb

Interface SmbPipeHandle

All Superinterfaces:
AutoCloseable
All Known Subinterfaces:
SmbPipeHandleInternal
public interface SmbPipeHandle extends AutoCloseable
Handle to an open named pipe
Author:
mbechler

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    InputStream
    getInput()
    Gets the input stream for reading from this pipe.
    OutputStream
    getOutput()
    Gets the output stream for writing to this pipe.
    SmbPipeResource
    getPipe()
    Gets the pipe resource associated with this handle.
    boolean
    isOpen()
    Tests whether this file descriptor is open and valid.
    boolean
    isStale()
    Tests whether this file descriptor was previously open but has become invalid.
    <T extends SmbPipeHandle>
    T
    unwrap(Class<T> type)
    Unwraps this handle to the specified type.

  • Method Details

    • getPipe

      SmbPipeResource getPipe()
      Gets the pipe resource associated with this handle.
      Returns:
      the pipe

    • getInput

      InputStream getInput() throws CIFSException
      Gets the input stream for reading from this pipe.
      Returns:
      this pipe's input stream
      Throws:
      CIFSException - if an error occurs getting the input stream

    • getOutput

      OutputStream getOutput() throws CIFSException
      Gets the output stream for writing to this pipe.
      Returns:
      this pipe's output stream
      Throws:
      CIFSException - if an error occurs getting the output stream

    • close

      void close() throws CIFSException
      Specified by:
      close in interface AutoCloseable
      Throws:
      CIFSException - if an error occurs closing the handle
      See Also:

    • isOpen

      boolean isOpen()
      Tests whether this file descriptor is open and valid.
      Returns:
      whether the FD is open and valid

    • isStale

      boolean isStale()
      Tests whether this file descriptor was previously open but has become invalid.
      Returns:
      whether the FD was previously open but became invalid

    • unwrap

      <T extends SmbPipeHandle> T unwrap(Class<T> type)
      Unwraps this handle to the specified type.
      Type Parameters:
      T - the type to unwrap to
      Parameters:
      type - the class of the type to unwrap to
      Returns:
      unwrapped instance