Class PipeShare

java.lang.Object
com.hierynomus.smbj.share.Share
com.hierynomus.smbj.share.PipeShare
All Implemented Interfaces:
AutoCloseable

public class PipeShare extends Share
  • Field Details

  • Constructor Details

  • Method Details

    • waitForPipe

      public boolean waitForPipe(String name)
      Requests that the server wait until an instance of the specified named pipe is available for connection.

      Name must not include the "\pipe\", so if the operation was on \\server\pipe\pipename, the name would be "pipename".

      This method requests that the server wait indefinitely. To specify a maximum wait time use waitForPipe(String, long, TimeUnit).

      Parameters:
      name - the name of the named pipe.
      Returns:
      true if an instance of the pipe is available; false if a timeout occurred
      Throws:
      SMBApiException - if an error occurs while waiting for an instance of the pipe to become available
    • waitForPipe

      public boolean waitForPipe(String name, long timeout, TimeUnit timeoutUnit)
      Requests that the server wait until an instance of the specified named pipe is available for connection.

      Name must not include the "\pipe\", so if the operation was on \\server\pipe\pipename, the name would be "pipename".

      Parameters:
      name - the name of the named pipe.
      timeout - the amount of time to wait until an instance is available
      timeoutUnit - the unit in which timeout is specified
      Returns:
      true if an instance of the pipe is available; false if a timeout occurred
      Throws:
      SMBApiException - if an error occurs while waiting for an instance of the pipe to become available
    • open

      public NamedPipe open(String name, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> attributes, Set<SMB2ShareAccess> shareAccesses, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
    • openFileId

      public SMB2FileId openFileId(String name, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
    • closeFileId

      public void closeFileId(SMB2FileId fileId) throws SMBApiException
      Overrides:
      closeFileId in class Share
      Throws:
      SMBApiException