Package com.hierynomus.smbj.share
Class PipeShare
java.lang.Object
com.hierynomus.smbj.share.Share
com.hierynomus.smbj.share.PipeShare
- All Implemented Interfaces:
AutoCloseable
-
Field Summary
FieldsFields inherited from class com.hierynomus.smbj.share.Share
session, smbPath, treeConnect
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
closeFileId
(SMB2FileId fileId) open
(String name, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> attributes, Set<SMB2ShareAccess> shareAccesses, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions) openFileId
(String name, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions) boolean
waitForPipe
(String name) Requests that the server wait until an instance of the specified named pipe is available for connection.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.Methods inherited from class com.hierynomus.smbj.share.Share
changeNotifyAsync, close, closeFileIdNoWait, createFile, equals, flush, getCreateStatusHandler, getDialect, getReadBufferSize, getReadTimeout, getSmbPath, getTreeConnect, getWriteBufferSize, hashCode, ioctl, ioctl, ioctl, ioctl, ioctl, ioctl, ioctl, ioctlAsync, ioctlAsync, isConnected, openFileId, queryDirectory, queryInfo, read, readAsync, receive, receive, sendLockRequest, setInfo, write, writeAsync
-
Field Details
-
FSCTL_PIPE_WAIT
private static final int FSCTL_PIPE_WAIT- See Also:
-
-
Constructor Details
-
Method Details
-
waitForPipe
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
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 availabletimeoutUnit
- 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
- Overrides:
closeFileId
in classShare
- Throws:
SMBApiException
-