Module jcifs

Package org.codelibs.jcifs.smb.internal.smb2.ioctl

Class SrvPipePeekResponse

java.lang.Object

org.codelibs.jcifs.smb.internal.smb2.ioctl.SrvPipePeekResponse

All Implemented Interfaces:

Decodable

public class SrvPipePeekResponse
extends Object
implements Decodable

Response structure for SMB2 IOCTL pipe peek operation. Provides information about data available in a named pipe.

Author:

svella

Constructor Summary

Constructors

Constructor	Description
SrvPipePeekResponse()	Constructs a new SrvPipePeekResponse.

Method Summary

Modifier and Type	Method	Description
int	decode(byte[] buffer, int bufferIndex, int len)	Decode data from a byte buffer
byte[]	getData()	Gets the data peeked from the pipe
int	getMessageLength()	Gets the length of the first message in the pipe
int	getNamedPipeState()	Gets the current state of the named pipe
int	getNumberOfMessages()	Gets the number of messages available in the pipe
int	getReadDataAvailable()	Gets the amount of data available to read from the pipe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SrvPipePeekResponse

public SrvPipePeekResponse()

Constructs a new SrvPipePeekResponse. This response contains information about data available in a named pipe.

Method Details

getNamedPipeState

public int getNamedPipeState()

Gets the current state of the named pipe

Returns:

the namedPipeState

getReadDataAvailable

public int getReadDataAvailable()

Gets the amount of data available to read from the pipe

Returns:

the readDataAvailable

getNumberOfMessages

public int getNumberOfMessages()

Gets the number of messages available in the pipe

Returns:

the numberOfMessages

getMessageLength

public int getMessageLength()

Gets the length of the first message in the pipe

Returns:

the messageLength

getData

public byte[] getData()

Gets the data peeked from the pipe

Returns:

the data

decode

public int decode(byte[] buffer,
 int bufferIndex,
 int len)
           throws SMBProtocolDecodingException

Decode data from a byte buffer

Specified by:

decode in interface Decodable

Parameters:

buffer - the byte buffer containing the data to decode

bufferIndex - the starting index in the buffer

len - the maximum length of data to decode

Returns:

decoded length

Throws:

SMBProtocolDecodingException - if decoding fails

See Also:

• Decodable.decode(byte[], int, int)