com.sun.corba.ee.impl.encoding

Class BufferManagerWrite

java.lang.Object

com.sun.corba.ee.impl.encoding.BufferManagerWrite

Direct Known Subclasses:

BufferManagerWriteGrow, BufferManagerWriteStream

public abstract class BufferManagerWrite
extends Object

Defines the contract between the BufferManager and CDR stream on the writing side. The CDR stream calls back to the BufferManagerWrite when it needs more room in the output buffer to continue. The BufferManager can then grow the output buffer or use some kind of fragmentation technique.

Field Summary

Fields

Modifier and Type	Field and Description
protected ORB	orb
protected Object	outputObject
protected boolean	sentFullMessage
protected static ORBUtilSystemException	wrapper

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the BufferManagerWrite and do any outstanding cleanup.
abstract int	getBufferSize() Returns the correct buffer size for this type of buffer manager as set in the ORB.
abstract boolean	isFragmentOnOverflow() Returns true if this buffer manager fragments when an overflow occurs.
protected abstract ByteBuffer	overflow(ByteBuffer byteBuffer, int numBytesNeeded)
abstract void	sendMessage() Called after Stub._invoke (i.e., before complete message has been sent).
abstract boolean	sentFragment() Has the stream sent out any fragments so far?
boolean	sentFullMessage() Has the entire message been sent? (Has sendMessage been called?)
void	setOutputObject(Object outputObject) A reference to the connection level stream will be required when sending fragments.

Methods inherited from class java.lang.Object

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

Field Detail

orb

protected ORB orb

wrapper

protected static final ORBUtilSystemException wrapper

outputObject

protected Object outputObject

sentFullMessage

protected boolean sentFullMessage

Method Detail

sentFragment

public abstract boolean sentFragment()

Has the stream sent out any fragments so far?

sentFullMessage

public boolean sentFullMessage()

Has the entire message been sent? (Has sendMessage been called?)

getBufferSize

public abstract int getBufferSize()

Returns the correct buffer size for this type of buffer manager as set in the ORB.

overflow

protected abstract ByteBuffer overflow(ByteBuffer byteBuffer,
                                       int numBytesNeeded)

isFragmentOnOverflow

public abstract boolean isFragmentOnOverflow()

Returns true if this buffer manager fragments when an overflow occurs.

sendMessage

public abstract void sendMessage()

Called after Stub._invoke (i.e., before complete message has been sent). IIOPOutputStream.writeTo called from IIOPOutputStream.invoke Case: overflow was never called (bbwi.buf contains complete message). Backpatch size field. If growing or collecting: this.bufQ.put(bbwi). this.bufQ.iterate // However, see comment in getBufferQ this.connection.send(fragment) If streaming: this.connection.send(bbwi). Case: overflow was called N times (bbwi.buf contains last buffer). If growing or collecting: this.bufQ.put(bbwi). backpatch size field in first buffer. this.bufQ.iterate // However, see comment in getBufferQ this.connection.send(fragment) If streaming: backpatch fragment size field in bbwi.buf. Set no more fragments bit. this.connection.send(bbwi).

setOutputObject

public void setOutputObject(Object outputObject)

A reference to the connection level stream will be required when sending fragments.

close

public abstract void close()

Close the BufferManagerWrite and do any outstanding cleanup.