org.infinispan.marshall
Interface StreamingMarshaller

All Superinterfaces:
Marshaller
All Known Implementing Classes:
AbstractStreamingMarshaller, JBossMarshaller, VersionAwareMarshaller

@ThreadSafe
public interface StreamingMarshaller
extends Marshaller

A specialization of Marshaller that supports streams.

A single instance of any implementation is shared by multiple threads, so implementations need to be threadsafe, and preferably immutable.

Since:
4.0
Author:
Manik Surtani, Galder ZamarreƱo
See Also:
Marshaller

Method Summary
 void finishObjectInput(ObjectInput oi)
          Finish using the given ObjectInput.
 void finishObjectOutput(ObjectOutput oo)
          Finish using the given ObjectOutput.
 Object objectFromInputStream(InputStream is)
           
 Object objectFromObjectStream(ObjectInput in)
          Unmarshalls an object from an ObjectInput
 void objectToObjectStream(Object obj, ObjectOutput out)
          Marshalls an object to a given ObjectOutput
 ObjectInput startObjectInput(InputStream is, boolean isReentrant)
          Create and open a new ObjectInput for the given input stream.
 ObjectOutput startObjectOutput(OutputStream os, boolean isReentrant)
          Create and open an ObjectOutput instance for the given output stream.
 
Methods inherited from interface org.infinispan.marshall.Marshaller
isMarshallable, objectFromByteBuffer, objectFromByteBuffer, objectToBuffer, objectToByteBuffer, objectToByteBuffer
 

Method Detail

startObjectOutput

ObjectOutput startObjectOutput(OutputStream os,
                               boolean isReentrant)
                               throws IOException

Create and open an ObjectOutput instance for the given output stream. This method should be used for opening data outputs when multiple objectToObjectStream() calls will be made before the stream is closed by calling finishObjectOutput().

This method also takes a boolean that represents whether this particular call to startObjectOutput() is reentrant or not. A call to startObjectOutput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectOutput() first.

To potentially speed up calling startObjectOutput multiple times in a non-reentrant way, i.e. startObjectOutput/finishObjectOutput...startObjectOutput/finishObjectOutput...etc, which is is the most common case, the StreamingMarshaller implementation could potentially use some mechanisms to speed up this startObjectOutput call.

On the other hand, when a call is reentrant, i.e. startObjectOutput/startObjectOutput(reentrant)...finishObjectOutput/finishObjectOutput, the StreamingMarshaller implementation might treat it differently. An example of reentrancy would be marshalling of MarshalledValue. When sending or storing a MarshalledValue, a call to startObjectOutput() would occur so that the stream is open and following, a 2nd call could occur so that MarshalledValue's raw byte array version is calculated and sent accross. This enables lazy deserialization on the receiver side which is performance gain. The StreamingMarshaller implementation could decide that it needs a separate ObjectOutput or similar for the 2nd call since it's aim is only to get the raw byte array version and the close finish with it.

Parameters:
os - output stream
isReentrant - whether the call is reentrant or not.
Returns:
ObjectOutput to write to
Throws:
IOException

finishObjectOutput

void finishObjectOutput(ObjectOutput oo)
Finish using the given ObjectOutput. After opening a ObjectOutput and calling objectToObjectStream() mutliple times, use this method to flush the data and close if necessary

Parameters:
oo - data output that finished using

objectToObjectStream

void objectToObjectStream(Object obj,
                          ObjectOutput out)
                          throws IOException
Marshalls an object to a given ObjectOutput

Parameters:
obj - object to marshall
out - stream to marshall to
Throws:
IOException

startObjectInput

ObjectInput startObjectInput(InputStream is,
                             boolean isReentrant)
                             throws IOException

Create and open a new ObjectInput for the given input stream. This method should be used for opening data inputs when multiple objectFromObjectStream() calls will be made before the stream is closed.

This method also takes a boolean that represents whether this particular call to startObjectInput() is reentrant or not. A call to startObjectInput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectInput() first.

To potentially speed up calling startObjectInput multiple times in a non-reentrant way, i.e. startObjectInput/finishObjectInput...startObjectInput/finishObjectInput...etc, which is is the most common case, the StreamingMarshaller implementation could potentially use some mechanisms to speed up this startObjectInput call.

Parameters:
is - input stream
isReentrant - whether the call is reentrant or not.
Returns:
ObjectInput to read from
Throws:
IOException

finishObjectInput

void finishObjectInput(ObjectInput oi)
Finish using the given ObjectInput. After opening a ObjectInput and calling objectFromObjectStream() mutliple times, use this method to flush the data and close if necessary

Parameters:
oi - data input that finished using

objectFromObjectStream

Object objectFromObjectStream(ObjectInput in)
                              throws IOException,
                                     ClassNotFoundException
Unmarshalls an object from an ObjectInput

Parameters:
in - stream to unmarshall from
Throws:
IOException
ClassNotFoundException

objectFromInputStream

Object objectFromInputStream(InputStream is)
                             throws IOException,
                                    ClassNotFoundException
Throws:
IOException
ClassNotFoundException

Google Analytics

Copyright © 2010 JBoss, a division of Red Hat. All Rights Reserved.