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 [6/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/v2/ActiveMQTextMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTextMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTextMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQTopicMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTopicMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTopicMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/BaseCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BaseCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BaseCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/BrokerIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/BrokerInfoMarshaller.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/v2/ConnectionControlMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionControlMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionControlMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionControlMarshaller.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/v2/ConnectionErrorMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionErrorMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionErrorMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionErrorMarshaller.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/v2/ConnectionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionIdMarshaller.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/v2/ConnectionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConnectionInfoMarshaller.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/v2/ConsumerControlMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerControlMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerControlMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerControlMarshaller.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/v2/ConsumerIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerIdMarshaller.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/v2/ConsumerInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ConsumerInfoMarshaller.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/v2/ControlCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ControlCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ControlCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ControlCommandMarshaller.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/v2/DataArrayResponseMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataArrayResponseMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataArrayResponseMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataArrayResponseMarshaller.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/v2/DataResponseMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataResponseMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataResponseMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DataResponseMarshaller.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/v2/DestinationInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DestinationInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DestinationInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DestinationInfoMarshaller.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/v2/DiscoveryEventMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DiscoveryEventMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DiscoveryEventMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/DiscoveryEventMarshaller.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/v2/ExceptionResponseMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ExceptionResponseMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ExceptionResponseMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ExceptionResponseMarshaller.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/v2/FlushCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/FlushCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/FlushCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/FlushCommandMarshaller.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,