You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ta...@apache.org on 2009/05/21 12:26:17 UTC
svn commit: r777039 [2/15] - in
/activemq/activemq-cpp/trunk/activemq-cpp/src/main: activemq/cmsutil/
activemq/commands/ activemq/exceptions/ activemq/io/ activemq/transport/
activemq/transport/failover/ activemq/transport/mock/
activemq/transport/tcp/...
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/BaseDataStreamMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/BaseDataStreamMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/BaseDataStreamMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/BaseDataStreamMarshaller.h Thu May 21 10:26:09 2009
@@ -32,7 +32,9 @@
/**
* Base class for all Marshallers that marshal DataStructures to and
- * from the wire using the OpenWire protocal.
+ * from the wire using the OpenWire protocol.
+ *
+ * @since 2.0
*/
class AMQCPP_API BaseDataStreamMarshaller : public DataStreamMarshaller {
private:
@@ -57,7 +59,7 @@
throw ( decaf::io::IOException ) { return 0; }
/**
- * Tight Marhsal to the given stream
+ * Tight Marshal to the given stream
* @param format - The OpenwireFormat properties
* @param command - the object to Marshal
* @param ds - the DataOutputStream to Marshal to
@@ -71,11 +73,11 @@
throw ( decaf::io::IOException ) {}
/**
- * Tight Un-marhsal to the given stream
+ * Tight Un-Marshal to the given stream
* @param format - The OpenwireFormat properties
* @param command - the object to Un-Marshal
* @param dis - the DataInputStream to Un-Marshal from
- * @param bs - boolean stream to unmarshal from.
+ * @param bs - boolean stream to Un-Marshal from.
* @throws IOException if an error occurs.
*/
virtual void tightUnmarshal( OpenWireFormat* format AMQCPP_UNUSED,
@@ -85,7 +87,7 @@
throw ( decaf::io::IOException ) {}
/**
- * Tight Marhsal to the given stream
+ * Tight Marshal to the given stream
* @param format - The OpenwireFormat properties
* @param command - the object to Marshal
* @param ds - DataOutputStream to marshal to
@@ -97,7 +99,7 @@
throw ( decaf::io::IOException ) {}
/**
- * Loose Un-marhsal to the given stream
+ * Loose Un-Marshal to the given stream
* @param format - The OpenwireFormat properties
* @param command - the object to Un-Marshal
* @param dis - the DataInputStream to Un-Marshal from
@@ -143,9 +145,9 @@
protected:
/**
- * Tight Unmarshall the cached object
+ * Tight Unmarshal the cached object
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
+ * @param dataIn - stream to read marshaled form from
* @param bs - boolean stream to marshal to.
* @returns pointer to a new DataStructure Object
* @throws IOException if an error occurs.
@@ -156,8 +158,8 @@
utils::BooleanStream* bs ) throw ( decaf::io::IOException );
/**
- * Tightly marshalls the passed DataStructure based object to the passed
- * BooleanStream returning the size of the data marshalled
+ * Tightly marshals the passed DataStructure based object to the passed
+ * BooleanStream returning the size of the data marshaled
* @param wireFormat - The OpenwireFormat properties
* @param data - DataStructure Object Pointer to marshal
* @param bs - boolean stream to marshal to.
@@ -170,12 +172,12 @@
throw ( decaf::io::IOException );
/**
- * Tightly marshalls the passed DataStructure based object to the passed
+ * Tightly marshals the passed DataStructure based object to the passed
* streams returning nothing
* @param wireFormat - The OpenwireFormat properties
* @param data - DataStructure Object Pointer to marshal
* @param bs - boolean stream to marshal to.
- * @param dataOut - stream to write marshalled data to
+ * @param dataOut - stream to write marshaled data to
* @throws IOException if an error occurs.
*/
virtual void tightMarshalCachedObject2( OpenWireFormat* wireFormat,
@@ -185,12 +187,11 @@
throw ( decaf::io::IOException );
/**
- * Loosely marshalls the passed DataStructure based object to the passed
+ * Loosely marshals the passed DataStructure based object to the passed
* stream returning nothing
* @param wireFormat - The OpenwireFormat properties
* @param data - DataStructure Object Pointer to marshal
- * @param bs - boolean stream to marshal to.
- * @param dataOut - stream to write marshalled data to
+ * @param dataOut - stream to write marshaled data to
* @throws IOException if an error occurs.
*/
virtual void looseMarshalCachedObject( OpenWireFormat* wireFormat,
@@ -199,9 +200,9 @@
throw ( decaf::io::IOException );
/**
- * Loose Unmarshall the cached object
+ * Loose Unmarshal the cached object
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
+ * @param dataIn - stream to read marshaled form from
* @returns pointer to a new DataStructure Object
* @throws IOException if an error occurs.
*/
@@ -210,8 +211,8 @@
decaf::io::DataInputStream* dataIn ) throw ( decaf::io::IOException );
/**
- * Tightly marshalls the passed DataStructure based object to the passed
- * BooleanStream returning the size of the data marshalled
+ * Tightly marshals the passed DataStructure based object to the passed
+ * BooleanStream returning the size of the data marshaled
* @param wireFormat - The OpenwireFormat properties
* @param object - DataStructure Object Pointer to marshal
* @param bs - boolean stream to marshal to.
@@ -224,12 +225,12 @@
throw ( decaf::io::IOException );
/**
- * Tightly marshalls the passed DataStructure based object to the passed
+ * Tightly marshals the passed DataStructure based object to the passed
* streams returning nothing
* @param wireFormat - The OpenwireFormat properties
* @param object - DataStructure Object Pointer to marshal
* @param bs - boolean stream to marshal to.
- * @param dataOut - stream to write marshalled data to
+ * @param dataOut - stream to write marshaled data to
* @throws IOException if an error occurs.
*/
virtual void tightMarshalNestedObject2( OpenWireFormat* wireFormat,
@@ -239,9 +240,9 @@
throw ( decaf::io::IOException );
/**
- * Tight Unmarshall the nested object
+ * Tight Unmarshal the nested object
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
+ * @param dataIn - stream to read marshaled form from
* @param bs - boolean stream to marshal to.
* @returns pointer to a new DataStructure Object
* @throws IOException if an error occurs.
@@ -252,9 +253,9 @@
utils::BooleanStream* bs ) throw ( decaf::io::IOException );
/**
- * Loose Unmarshall the nested object
+ * Loose Unmarshal the nested object
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
+ * @param dataIn - stream to read marshaled form from
* @returns pointer to a new DataStructure Object
* @throws IOException if an error occurs.
*/
@@ -266,7 +267,7 @@
* Loose marshall the nested object
* @param wireFormat - The OpenwireFormat properties
* @param object - DataStructure Object Pointer to marshal
- * @param dataOut - stream to write marshalled data to
+ * @param dataOut - stream to write marshaled data to
* @throws IOException if an error occurs.
*/
virtual void looseMarshalNestedObject( OpenWireFormat* wireFormat,
@@ -275,10 +276,10 @@
throw ( decaf::io::IOException );
/**
- * Performs Tight Unmarshalling of String Objects
+ * Performs Tight Unmarshaling of String Objects
* @param dataIn - the DataInputStream to Un-Marshal from
* @param bs - boolean stream to unmarshal from.
- * @returns the unmarshalled string.
+ * @returns the unmarshaled string.
* @throws IOException if an error occurs.
*/
virtual std::string tightUnmarshalString( decaf::io::DataInputStream* dataIn,
@@ -287,10 +288,10 @@
/**
* Tight Marshals the String to a Booleans Stream Object, returns
- * the marshalled size.
+ * the marshaled size.
* @param value - string to marshal
* @param bs - BooleanStream to use.
- * @returns size of marshalled string.
+ * @returns size of marshaled string.
* @throws IOException if an error occurs.
*/
virtual int tightMarshalString1( const std::string& value,
@@ -312,7 +313,7 @@
/**
* Loose Marshal the String to the DataOuputStream passed
* @param value - string to marshal
- * @param dataOut - stream to write marshalled form to
+ * @param dataOut - stream to write marshaled form to
* @throws IOException if an error occurs.
*/
virtual void looseMarshalString( const std::string value,
@@ -321,8 +322,8 @@
/**
* Loose Un-Marshal the String to the DataOuputStream passed
- * @param dataIn - stream to read marshalled form from
- * @return the unmarshalled string
+ * @param dataIn - stream to read marshaled form from
+ * @return the unmarshaled string
* @throws IOException if an error occurs.
*/
virtual std::string looseUnmarshalString( decaf::io::DataInputStream* dataIn )
@@ -345,7 +346,7 @@
* Tightly marshal the long long to the Streams passed.
* @param wireFormat - The OpenwireFormat properties
* @param value - long long to marshal
- * @param dataOut - stream to write marshalled form to
+ * @param dataOut - stream to write marshaled form to
* @param bs - boolean stream to marshal to.
* @throws IOException if an error occurs.
*/
@@ -358,9 +359,9 @@
/**
* Tight marshal the long long type.
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
+ * @param dataIn - stream to read marshaled form from
* @param bs - boolean stream to marshal to.
- * @returns the unmarshalled long long
+ * @returns the unmarshaled long long
* @throws IOException if an error occurs.
*/
virtual long long tightUnmarshalLong( OpenWireFormat* wireFormat,
@@ -383,8 +384,8 @@
/**
* Loose marshal the long long type.
* @param wireFormat - The OpenwireFormat properties
- * @param dataIn - stream to read marshalled form from
- * @returns the unmarshalled long long
+ * @param dataIn - stream to read marshaled form from
+ * @returns the unmarshaled long long
* @throws IOException if an error occurs.
*/
virtual long long looseUnmarshalLong( OpenWireFormat* wireFormat,
@@ -395,7 +396,7 @@
* Tight Unmarshal an array of char
* @param dataIn - the DataInputStream to Un-Marshal from
* @param bs - boolean stream to unmarshal from.
- * @returns the unmarshalled vector of chars.
+ * @returns the unmarshaled vector of chars.
* @throws IOException if an error occurs.
*/
virtual std::vector<unsigned char> tightUnmarshalByteArray(
@@ -417,7 +418,7 @@
* @param dataIn - the DataInputStream to Un-Marshal from
* @param bs - boolean stream to unmarshal from.
* @param size - size of the const array to unmarshal
- * @returns the unmarshalled vector of chars.
+ * @returns the unmarshaled vector of chars.
* @throws IOException if an error occurs.
*/
virtual std::vector<unsigned char> tightUnmarshalConstByteArray(
@@ -429,14 +430,12 @@
* Tight Unmarshal a fixed size array from that data input stream
* and return an stl vector of char as the resultant.
* @param dataIn - the DataInputStream to Un-Marshal from
- * @param bs - boolean stream to unmarshal from.
* @param size - size of the const array to unmarshal
- * @returns the unmarshalled vector of chars.
+ * @returns the unmarshaled vector of chars.
* @throws IOException if an error occurs.
*/
virtual std::vector<unsigned char> looseUnmarshalConstByteArray(
- decaf::io::DataInputStream* dataIn,
- int size ) throw ( decaf::io::IOException );
+ decaf::io::DataInputStream* dataIn, int size ) throw ( decaf::io::IOException );
/**
* Tight Unarshall the Error object
@@ -452,7 +451,7 @@
utils::BooleanStream* bs ) throw ( decaf::io::IOException );
/**
- * Tight Marshall the Error object
+ * Tight Marshal the Error object
* @param wireFormat - The OpenwireFormat properties
* @param data - Error to Marshal
* @param bs - boolean stream to marshal to.
@@ -465,7 +464,7 @@
throw ( decaf::io::IOException );
/**
- * Tight Marshall the Error object
+ * Tight Marshal the Error object
* @param wireFormat - The OpenwireFormat properties
* @param data - Error to Marshal
* @param dataOut - stream to write marshalled data to
@@ -479,7 +478,7 @@
throw ( decaf::io::IOException );
/**
- * Loose Unarshall the Error object
+ * Loose Unarshal the Error object
* @param wireFormat - The OpenwireFormat properties
* @param dataIn - stream to read marshalled form from
* @returns pointer to a new DataStructure Object
@@ -490,7 +489,7 @@
decaf::io::DataInputStream* dataIn ) throw ( decaf::io::IOException );
/**
- * Tight Marshall the Error object
+ * Tight Marshal the Error object
* @param wireFormat - The OpenwireFormat properties
* @param data - Error to Marshal
* @param dataOut - stream to write marshalled data to
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/PrimitiveTypesMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/PrimitiveTypesMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/PrimitiveTypesMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/PrimitiveTypesMarshaller.h Thu May 21 10:26:09 2009
@@ -45,10 +45,14 @@
virtual ~PrimitiveTypesMarshaller() {}
/**
- * Static Marshal of a primitive map object
- * @param Map to Marshal
- * @param Reference to a byte array to house the data
- * @throws CMSException
+ * Static Marshal of a primitive map object.
+ *
+ * @param map
+ * Map to Marshal.
+ * @param dest
+ * Reference to a byte array to house the data.
+ *
+ * @throws Exception
*/
static void marshal( const util::PrimitiveMap* map,
std::vector<unsigned char>& dest )
@@ -57,18 +61,27 @@
/**
* Static Map Unmarshaler, takes an array of bytes and returns a
* new instance of a PrimitiveMap object. Caller owns the pointer.
- * @param Map to Unmarshal into
- * @param reference to a byte array to read data from.
+ *
+ * @param map
+ * Map to Unmarshal into
+ * @param src
+ * Reference to a byte array to read data from.
+ *
+ * @throws Exception
*/
static void unmarshal( util::PrimitiveMap* map,
const std::vector<unsigned char>& src )
throw ( decaf::lang::Exception );
/**
- * Static Marshal of a primitive map object
- * @param Map to Marshal
- * @param Reference to a byte array to house the data
- * @throws CMSException
+ * Static Marshal of a primitive map object.
+ *
+ * @param list
+ * The list object to Marshal
+ * @param dest
+ * Reference to a byte array to house the data
+ *
+ * @throws Exception
*/
static void marshal( const util::PrimitiveList* list,
std::vector<unsigned char>& dest )
@@ -77,8 +90,13 @@
/**
* Static Map Unmarshaler, takes an array of bytes and returns a
* new instance of a PrimitiveMap object. Caller owns the pointer.
- * @param Map to Unmarshal into
- * @param reference to a byte array to read data from.
+ *
+ * @param list
+ * The list object to Un-marshal
+ * @param src
+ * Reference to a byte array to read data from.
+ *
+ * @throws Exception
*/
static void unmarshal( util::PrimitiveList* list,
const std::vector<unsigned char>& src )
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBlobMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBlobMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBlobMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBlobMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBytesMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBytesMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBytesMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQBytesMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQDestinationMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQDestinationMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQDestinationMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQDestinationMarshaller.h Thu May 21 10:26:09 2009
@@ -53,11 +53,14 @@
virtual ~ActiveMQDestinationMarshaller() {}
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -66,10 +69,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -77,10 +83,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,9 +98,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -99,9 +111,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMapMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMapMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMapMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMapMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQObjectMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQObjectMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQObjectMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQObjectMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQQueueMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQQueueMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQQueueMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQQueueMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQStreamMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQStreamMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQStreamMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQStreamMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempDestinationMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempDestinationMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempDestinationMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempDestinationMarshaller.h Thu May 21 10:26:09 2009
@@ -53,11 +53,14 @@
virtual ~ActiveMQTempDestinationMarshaller() {}
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -66,10 +69,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -77,10 +83,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,9 +98,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -99,9 +111,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempQueueMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempQueueMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempQueueMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempQueueMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempTopicMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempTopicMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempTopicMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTempTopicMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTextMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTextMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTextMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTextMessageMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTopicMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTopicMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTopicMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ActiveMQTopicMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BaseCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BaseCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BaseCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BaseCommandMarshaller.h Thu May 21 10:26:09 2009
@@ -53,11 +53,14 @@
virtual ~BaseCommandMarshaller() {}
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -66,10 +69,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -77,10 +83,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,9 +98,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -99,9 +111,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BrokerIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BrokerIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BrokerIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/BrokerIdMarshaller.h Thu May 21 10:26:09 2009
@@ -54,22 +54,27 @@
/**
* Creates a new instance of this marshalable type.
+ *
* @return new DataStructure object pointer caller owns it.
*/
virtual commands::DataStructure* createObject() const;
/**
* Get the Data Structure Type that identifies this Marshaler
+ *
* @return byte holding the data structure type value
*/
virtual unsigned char getDataStructureType() const;
/**
- * Un-marshal an object instance from the data input stream
- * @param wireFormat - describes the wire format of the broker
- * @param o - Object to be un-marshaled
- * @param dataIn - BinaryReader that provides that data
- * @param bs - BooleanStream
+ * Un-marshal an object instance from the data input stream.
+ *
+ * @param wireFormat - describes the wire format of the broker.
+ * @param dataStructure - Object to be un-marshaled.
+ * @param dataIn - BinaryReader that provides that data.
+ * @param bs - BooleanStream stream used to unpack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void tightUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -78,10 +83,13 @@
/**
* Write the booleans that this object uses to a BooleanStream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
- * @param bs - BooleanStream
- * @returns int
+ * @param dataStructure - Object to be marshaled
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ * @returns int value indicating the size of the marshaled object.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual int tightMarshal1( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -89,10 +97,13 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryReader that provides that data sink
- * @param bs - BooleanStream
+ * @param bs - BooleanStream stream used to pack bits from the wire.
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void tightMarshal2( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -101,9 +112,12 @@
/**
* Un-marshal an object instance from the data input stream
+ *
* @param wireFormat - describes the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataIn - BinaryReader that provides that data source
+ *
+ * @throws IOException if an error occurs during the unmarshal.
*/
virtual void looseUnmarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,
@@ -111,9 +125,12 @@
/**
* Write a object instance to data output stream
+ *
* @param wireFormat - describs the wire format of the broker
- * @param o - Object to be marshaled
+ * @param dataStructure - Object to be marshaled
* @param dataOut - BinaryWriter that provides that data sink
+ *
+ * @throws IOException if an error occurs during the marshal.
*/
virtual void looseMarshal( OpenWireFormat* wireFormat,
commands::DataStructure* dataStructure,