FileDocCategorySizeDatePackage
SmbNamedPipe.javaAPI DocJCIFS 1.3.17 API7685Tue Oct 18 15:26:24 BST 2011jcifs.smb

SmbNamedPipe

public class SmbNamedPipe extends SmbFile
This class will allow a Java program to read and write data to Named Pipes and Transact NamedPipes.

There are three Win32 function calls provided by the Windows SDK that are important in the context of using jCIFS. They are:

  • CallNamedPipe A message-type pipe call that opens, writes to, reads from, and closes the pipe in a single operation.
  • TransactNamedPipe A message-type pipe call that writes to and reads from an existing pipe descriptor in one operation.
  • CreateFile, ReadFile, WriteFile, and CloseFile A byte-type pipe can be opened, written to, read from and closed using the standard Win32 file operations.

The jCIFS API maps all of these operations into the standard Java XxxputStream interface. A special PIPE_TYPE flags is necessary to distinguish which type of Named Pipe behavior is desired.

SmbNamedPipe Constructor Examples
Code SampleDescription
new SmbNamedPipe( "smb://server/IPC$/PIPE/foo",
SmbNamedPipe.PIPE_TYPE_RDWR |
SmbNamedPipe.PIPE_TYPE_CALL );
Open the Named Pipe foo for reading and writing. The pipe will behave like the CallNamedPipe interface. 
new SmbNamedPipe( "smb://server/IPC$/foo",
SmbNamedPipe.PIPE_TYPE_RDWR |
SmbNamedPipe.PIPE_TYPE_TRANSACT );
Open the Named Pipe foo for reading and writing. The pipe will behave like the TransactNamedPipe interface. 
new SmbNamedPipe( "smb://server/IPC$/foo",
SmbNamedPipe.PIPE_TYPE_RDWR );
Open the Named Pipe foo for reading and writing. The pipe will behave as though the CreateFile, ReadFile, WriteFile, and CloseFile interface was being used.

See Using jCIFS to Connect to Win32 Named Pipes for a detailed description of how to use jCIFS with Win32 Named Pipe server processes.

Fields Summary
public static final int
PIPE_TYPE_RDONLY
The pipe should be opened read-only.
public static final int
PIPE_TYPE_WRONLY
The pipe should be opened only for writing.
public static final int
PIPE_TYPE_RDWR
The pipe should be opened for both reading and writing.
public static final int
PIPE_TYPE_CALL
Pipe operations should behave like the CallNamedPipe Win32 Named Pipe function.
public static final int
PIPE_TYPE_TRANSACT
Pipe operations should behave like the TransactNamedPipe Win32 Named Pipe function.
public static final int
PIPE_TYPE_DCE_TRANSACT
InputStream
pipeIn
OutputStream
pipeOut
int
pipeType
Constructors Summary
public SmbNamedPipe(String url, int pipeType)
Open the Named Pipe resource specified by the url parameter. The pipeType parameter should be at least one of the PIPE_TYPE flags combined with the bitwise OR operator |. See the examples listed above.


                                           

          
                               
        super( url );
        this.pipeType = pipeType;
        type = TYPE_NAMED_PIPE;
public SmbNamedPipe(String url, int pipeType, NtlmPasswordAuthentication auth)

        super( url, auth );
        this.pipeType = pipeType;
        type = TYPE_NAMED_PIPE;
public SmbNamedPipe(URL url, int pipeType, NtlmPasswordAuthentication auth)

        super( url, auth );
        this.pipeType = pipeType;
        type = TYPE_NAMED_PIPE;
Methods Summary
public java.io.InputStreamgetNamedPipeInputStream()
Return the InputStream used to read information from this pipe instance. Presumably data would first be written to the OutputStream associated with this Named Pipe instance although this is not a requirement (e.g. a read-only named pipe would write data to this stream on connection). Reading from this stream may block. Therefore it may be necessary that an addition thread be used to read and write to a Named Pipe.

        if( pipeIn == null ) {
            if(( pipeType & PIPE_TYPE_CALL ) == PIPE_TYPE_CALL ||
                    ( pipeType & PIPE_TYPE_TRANSACT ) == PIPE_TYPE_TRANSACT ) {
                pipeIn = new TransactNamedPipeInputStream( this );
            } else {
                pipeIn = new SmbFileInputStream(this,
                            (pipeType & 0xFFFF00FF) | SmbFile.O_EXCL);
            }
        }
        return pipeIn;
public java.io.OutputStreamgetNamedPipeOutputStream()
Return the OutputStream used to write information to this pipe instance. The act of writing data to this stream will result in response data recieved in the InputStream associated with this Named Pipe instance (unless of course it does not elicite a response or the pipe is write-only).

        if( pipeOut == null ) {
            if(( pipeType & PIPE_TYPE_CALL ) == PIPE_TYPE_CALL ||
                    ( pipeType & PIPE_TYPE_TRANSACT ) == PIPE_TYPE_TRANSACT ) {
                pipeOut = new TransactNamedPipeOutputStream( this );
            } else {
                pipeOut = new SmbFileOutputStream(this, false,
                            (pipeType & 0xFFFF00FF) | SmbFile.O_EXCL );
            }
        }
        return pipeOut;