Package jcifs.smb

Class SmbNamedPipe

  • All Implemented Interfaces:
    AutoCloseable, SmbConstants, SmbPipeResource, SmbResource
    public class SmbNamedPipe
extends SmbFile
implements SmbPipeResource
    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 Sample Description 
     new SmbNamedPipe("smb://server/IPC$/PIPE/foo", SmbNamedPipe.PIPE_TYPE_RDWR | SmbNamedPipe.PIPE_TYPE_CALL, context);
    		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, context);
    		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, context);
    		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.