activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tab...@apache.org
Subject svn commit: r777039 [5/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/...
Date Thu, 21 May 2009 10:26:17 GMT
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionIdMarshaller.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/SessionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SessionInfoMarshaller.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/ShutdownInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ShutdownInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ShutdownInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/ShutdownInfoMarshaller.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/SubscriptionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SubscriptionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SubscriptionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/SubscriptionInfoMarshaller.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/TransactionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionIdMarshaller.h Thu May 21 10:26:09 2009
@@ -53,11 +53,14 @@
         virtual ~TransactionIdMarshaller() {}
 
         /**
-         * 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/TransactionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/TransactionInfoMarshaller.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/WireFormatInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/WireFormatInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/WireFormatInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/WireFormatInfoMarshaller.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/XATransactionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/XATransactionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/XATransactionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v1/XATransactionIdMarshaller.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/ActiveMQBlobMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQBlobMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQBlobMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQBytesMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQBytesMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQBytesMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQDestinationMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQDestinationMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQDestinationMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQMapMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQMapMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQMapMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQObjectMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQObjectMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQObjectMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQQueueMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQQueueMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQQueueMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQStreamMessageMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQStreamMessageMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQStreamMessageMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQTempDestinationMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempDestinationMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempDestinationMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQTempQueueMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempQueueMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempQueueMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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/v2/ActiveMQTempTopicMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempTopicMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/ActiveMQTempTopicMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v2/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,



Mime
View raw message