Module jcifs

Package org.codelibs.jcifs.smb.impl

Interface SmbPipeHandleInternal

All Superinterfaces:

AutoCloseable, SmbPipeHandle

public interface SmbPipeHandleInternal
extends SmbPipeHandle

Internal interface for SMB pipe handle operations. This interface extends SmbPipeHandle with additional methods needed for internal pipe management and provides access to low-level pipe details.

Author:

mbechler

This interface is intended for internal use.

Method Summary

Modifier and Type	Method	Description
SmbFileHandle	ensureOpen()	Ensures that the file handle is open and returns it.
SmbTreeHandleInternal	ensureTreeConnected()	Ensures that the tree connection is established and returns it.
SmbPipeInputStream	getInput()	Gets the input stream for reading from this pipe.
SmbPipeOutputStream	getOutput()	Gets the output stream for writing to this pipe.
int	getPipeType()	Gets the type of this pipe.
byte[]	getSessionKey()	Gets the session key from the underlying SMB session.
int	recv(byte[] buf, int off, int length)	Receive data from the pipe
void	send(byte[] buf, int off, int length)	Send data to the pipe
int	sendrecv(byte[] buf, int off, int length, byte[] inB, int maxRecvCnt)	Performs a transaction on the pipe.

Methods inherited from interface org.codelibs.jcifs.smb.SmbPipeHandle

close, getPipe, isOpen, isStale, unwrap

Method Details

getPipeType

int getPipeType()

Gets the type of this pipe.

Returns:

the pipe type

getSessionKey

byte[] getSessionKey()
              throws CIFSException

Gets the session key from the underlying SMB session.

Returns:

session key of the underlying smb session

Throws:

CIFSException - if an error occurs retrieving the session key

getInput

SmbPipeInputStream getInput()
                     throws CIFSException

Gets the input stream for reading from this pipe.

Specified by:

getInput in interface SmbPipeHandle

Returns:

this pipe's input stream

Throws:

CIFSException - if an error occurs getting the input stream

getOutput

SmbPipeOutputStream getOutput()
                       throws CIFSException

Description copied from interface: SmbPipeHandle

Gets the output stream for writing to this pipe.

Specified by:

getOutput in interface SmbPipeHandle

Returns:

this pipe's output stream

Throws:

CIFSException - if an error occurs

ensureTreeConnected

SmbTreeHandleInternal ensureTreeConnected()
                                   throws CIFSException

Ensures that the tree connection is established and returns it.

Returns:

tree connection

Throws:

CIFSException - if an error occurs connecting to the tree

ensureOpen

SmbFileHandle ensureOpen()
                  throws CIFSException

Ensures that the file handle is open and returns it.

Returns:

file handle

Throws:

CIFSException - if an error occurs opening the file

recv

int recv(byte[] buf,
 int off,
 int length)
  throws IOException

Receive data from the pipe

Parameters:

buf - buffer to receive data into

off - offset in the buffer

length - maximum length to receive

Returns:

number of bytes received

Throws:

IOException - if an I/O error occurs

send

void send(byte[] buf,
 int off,
 int length)
   throws IOException

Send data to the pipe

Parameters:

buf - buffer containing data to send

off - offset in the buffer

length - length of data to send

Throws:

IOException - if an I/O error occurs

sendrecv

int sendrecv(byte[] buf,
 int off,
 int length,
 byte[] inB,
 int maxRecvCnt)
      throws IOException

Performs a transaction on the pipe.

Parameters:

buf - the buffer containing the transaction data

off - the offset in the buffer

length - the length of data to send

inB - the buffer to receive the response

maxRecvCnt - the maximum number of bytes to receive

Returns:

len the number of bytes received

Throws:

IOException - if an I/O error occurs