Class BufferManagerReadStream

java.lang.Object

com.sun.corba.ee.impl.encoding.BufferManagerReadStream

All Implemented Interfaces:

BufferManagerRead, MarkAndResetHandler

public class BufferManagerReadStream
extends Object
implements BufferManagerRead, MarkAndResetHandler

Field Summary

Fields

Modifier and Type	Field	Description
private int	cancelReqId
private boolean	endOfStream
private final BufferQueue	fragmentQueue
private LinkedList<ByteBuffer>	fragmentStack
private RestorableInputStream	inputStream
private boolean	markEngaged
private final ORB	orb
private boolean	receivedCancel
private Object	streamMemento
private static final ORBUtilSystemException	wrapper

Constructor Summary

Constructors

Constructor	Description
BufferManagerReadStream(ORB orb)

Method Summary

Modifier and Type	Method	Description
private void	bufferMessage(String msg, int bbAddr, String tail)
void	cancelProcessing(int requestId)	Signals that the processing be cancelled.
void	close(ByteBuffer byteBuffer)	Close BufferManagerRead and perform any outstanding cleanup.
void	fragmentationOccured(ByteBuffer newFrament)
protected ByteBufferPool	getByteBufferPool()
MarkAndResetHandler	getMarkAndResetHandler()	Returns the mark/reset handler for this stream.
void	init(Message msg)	Called once after creating this buffer manager and before it begins processing.
boolean	isFragmentOnUnderflow()	Returns true if this buffer manager reads fragments when it underflows.
private void	logBufferMessage(String prefix, ByteBuffer byteBuffer, String suffix)
void	mark(RestorableInputStream inputStream)
void	processFragment(ByteBuffer byteBuffer, FragmentMessage msg)	Case: Called from ReaderThread on complete message or fragments.
void	reset()
ByteBuffer	underflow(ByteBuffer byteBuffer)	Invoked when we run out of data to read.
private void	underflowMessage(String msg, int rid)

Methods inherited from class Object

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

Field Details

wrapper

private static final ORBUtilSystemException wrapper

receivedCancel

private volatile boolean receivedCancel

cancelReqId

private int cancelReqId

endOfStream

private boolean endOfStream

fragmentQueue

private final BufferQueue fragmentQueue

orb

private final ORB orb

markEngaged

private boolean markEngaged

fragmentStack

private LinkedList<ByteBuffer> fragmentStack

inputStream

private RestorableInputStream inputStream

streamMemento

private Object streamMemento

Constructor Details

BufferManagerReadStream

BufferManagerReadStream(ORB orb)

Method Details

cancelProcessing

public void cancelProcessing(int requestId)

Description copied from interface: BufferManagerRead

Signals that the processing be cancelled.

Specified by:

cancelProcessing in interface BufferManagerRead

Parameters:

requestId - ID of the request to cancel

bufferMessage

@InfoMethod
private void bufferMessage(String msg,
 int bbAddr,
 String tail)

processFragment

public void processFragment(ByteBuffer byteBuffer,
 FragmentMessage msg)

Description copied from interface: BufferManagerRead

Case: Called from ReaderThread on complete message or fragments. The given buffer may be entire message or a fragment. The ReaderThread finds the ReadBufferManager instance either in in a fragment map (when collecting - GIOP 1.2 phase 1) or in an active server requests map (when streaming - GIOP 1.2 phase 2). As a model for implementation see IIOPInputStream's constructor of the same name. There are going to be some variations.

Specified by:

processFragment in interface BufferManagerRead

Parameters:

byteBuffer - buffer to read from

msg - header of fragment

underflowMessage

@InfoMethod
private void underflowMessage(String msg,
 int rid)

underflow

public ByteBuffer underflow(ByteBuffer byteBuffer)

Description copied from interface: BufferManagerRead

Invoked when we run out of data to read. Obtains more data from the stream.

Specified by:

underflow in interface BufferManagerRead

Parameters:

byteBuffer - Current buffer, to return to pool

Returns:

Buffer containing new data

See Also:

• BufferManagerRead.isFragmentOnUnderflow()

isFragmentOnUnderflow

public boolean isFragmentOnUnderflow()

Description copied from interface: BufferManagerRead

Returns true if this buffer manager reads fragments when it underflows.

Specified by:

isFragmentOnUnderflow in interface BufferManagerRead

Returns:

if fragments will be read.

See Also:

• BufferManagerRead.underflow(ByteBuffer)

init

public void init(Message msg)

Description copied from interface: BufferManagerRead

Called once after creating this buffer manager and before it begins processing.

Specified by:

init in interface BufferManagerRead

Parameters:

msg - message header

close

public void close(ByteBuffer byteBuffer)

Description copied from interface: BufferManagerRead

Close BufferManagerRead and perform any outstanding cleanup.

Specified by:

close in interface BufferManagerRead

Parameters:

byteBuffer - buffer to return to the pool

logBufferMessage

private void logBufferMessage(String prefix,
 ByteBuffer byteBuffer,
 String suffix)

getByteBufferPool

protected ByteBufferPool getByteBufferPool()

mark

public void mark(RestorableInputStream inputStream)

Specified by:

mark in interface MarkAndResetHandler

fragmentationOccured

public void fragmentationOccured(ByteBuffer newFrament)

Specified by:

fragmentationOccured in interface MarkAndResetHandler

reset

public void reset()

Specified by:

reset in interface MarkAndResetHandler

getMarkAndResetHandler

public MarkAndResetHandler getMarkAndResetHandler()

Description copied from interface: BufferManagerRead

Returns the mark/reset handler for this stream.

Specified by:

getMarkAndResetHandler in interface BufferManagerRead

Returns:

The mark/reset handler for this stream.