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 [11/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/v3/PartialCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/PartialCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/PartialCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/PartialCommandMarshaller.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/v3/ProducerAckMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerAckMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerAckMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerAckMarshaller.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/v3/ProducerIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerIdMarshaller.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/v3/ProducerInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ProducerInfoMarshaller.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/v3/RemoveInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveInfoMarshaller.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/v3/RemoveSubscriptionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveSubscriptionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveSubscriptionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/RemoveSubscriptionInfoMarshaller.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/v3/ReplayCommandMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ReplayCommandMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ReplayCommandMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ReplayCommandMarshaller.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/v3/ResponseMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ResponseMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ResponseMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ResponseMarshaller.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/v3/SessionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SessionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SessionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/SessionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SessionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SessionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/ShutdownInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ShutdownInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/ShutdownInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/SubscriptionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SubscriptionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/SubscriptionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/TransactionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/TransactionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/TransactionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/TransactionInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/TransactionInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/TransactionInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/WireFormatInfoMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/WireFormatInfoMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/WireFormatInfoMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/v3/XATransactionIdMarshaller.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/XATransactionIdMarshaller.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/XATransactionIdMarshaller.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/marshal/v3/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/utils/HexTable.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/utils/HexTable.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/utils/HexTable.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/openwire/utils/HexTable.h Thu May 21 10:26:09 2009
@@ -41,10 +41,14 @@
virtual ~HexTable() {}
/**
- * Index operator for this Table, will throw an exeption if the
+ * Index operator for this Table, will throw an exception if the
* index requested is out of bounds for this table.
- * @param int - index to fetch
- * @returns string contianing the hex value if the index
+ *
+ * @param index
+ * The index of the value in the table to fetch.
+ *
+ * @returns string containing the hex value if the index
+ *
* @throws IndexOutOfBoundsException
*/
virtual const std::string& operator[]( std::size_t index )
@@ -54,7 +58,7 @@
/**
* Returns the max size of this Table.
- * @returns int size value
+ * @returns an integer size value
*/
virtual std::size_t size() const{
return table.size();
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompHelper.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompHelper.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompHelper.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompHelper.h Thu May 21 10:26:09 2009
@@ -109,7 +109,7 @@
/**
* Converts a ConsumerId instance to a Stomp ConsumerId String.
*
- * @param ConsumerId - the Consumer instance to convert.
+ * @param consumerId - the Consumer instance to convert.
* @return a Stomp Consumer Id String.
*/
std::string convertConsumerId( const Pointer<ConsumerId>& consumerId );
@@ -117,7 +117,7 @@
/**
* Converts a Stomp ConsumerId string to a ConsumerId
*
- * @param ConsumerId - the String Consumer Id to convert.
+ * @param consumerId - the String Consumer Id to convert.
* @return Pointer to a new ConsumerId.
*/
Pointer<ConsumerId> convertConsumerId( const std::string& consumerId );
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompWireFormat.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompWireFormat.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompWireFormat.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/activemq/wireformat/stomp/StompWireFormat.h Thu May 21 10:26:09 2009
@@ -53,8 +53,13 @@
* Stream based marshaling of a Command, this method blocks until the entire
* Command has been written out to the output stream.
*
- * @param command - The Command to Marshal
- * @param out - the output stream to write the command to.
+ * @param command
+ * The Command to Marshal to the output stream.
+ * @param transport
+ * The Transport that initiated this marshal call.
+ * @param out
+ * The output stream to write the command to.
+ *
* @throws IOException
*/
virtual void marshal( const Pointer<commands::Command>& command,
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardErrorOutputStream.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardErrorOutputStream.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardErrorOutputStream.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardErrorOutputStream.h Thu May 21 10:26:09 2009
@@ -65,9 +65,14 @@
/**
* Writes an array of bytes to the output stream.
- * @param buffer The array of bytes to write.
- * @param offset, the position to start writing in buffer.
- * @param len The number of bytes from the buffer to be written.
+ *
+ * @param buffer
+ * The array of bytes to write.
+ * @param offset
+ * The position to start writing in buffer.
+ * @param len
+ * The number of bytes from the buffer to be written.
+ *
* @throws decaf::io::IOException thrown if an error occurs.
* @throws NullPointerException if buffer is null.
*/
@@ -92,62 +97,22 @@
public:
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void lock() throw( decaf::lang::Exception ){
mutex.lock();
}
- /**
- * Unlocks the object.
- * @throws Exception
- */
- virtual void unlock() throw( decaf::lang::Exception ){
- mutex.unlock();
- }
-
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void wait() throw( decaf::lang::Exception ){
mutex.wait();
}
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling. This wait will timeout after the specified time
- * interval.
- * @param time in milliseconds to wait, or WAIT_INIFINITE
- * @throws Exception
- */
virtual void wait( unsigned long millisecs ) throw( decaf::lang::Exception ){
mutex.wait( millisecs );
}
- /**
- * Signals a waiter on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notify() throw( decaf::lang::Exception ){
mutex.notify();
}
- /**
- * Signals the waiters on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notifyAll() throw( decaf::lang::Exception ){
mutex.notifyAll();
}
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardInputStream.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardInputStream.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardInputStream.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardInputStream.h Thu May 21 10:26:09 2009
@@ -145,63 +145,26 @@
protected:
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void lock() throw( lang::Exception ){
mutex.lock();
}
- /**
- * Unlocks the object.
- * @throws Exception
- */
virtual void unlock() throw( lang::Exception ){
mutex.unlock();
}
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void wait() throw( lang::Exception ){
mutex.wait();
}
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling. This wait will timeout after the specified time
- * interval.
- * @param millisecs the time in milliseconds to wait, or
- * WAIT_INIFINITE
- * @throws Exception
- */
virtual void wait( unsigned long millisecs ) throw( lang::Exception ){
mutex.wait( millisecs );
}
- /**
- * Signals a waiter on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notify() throw( lang::Exception ){
mutex.notify();
}
- /**
- * Signals the waiters on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notifyAll() throw( lang::Exception ){
mutex.notifyAll();
}
Modified: activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardOutputStream.h
URL: http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardOutputStream.h?rev=777039&r1=777038&r2=777039&view=diff
==============================================================================
--- activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardOutputStream.h (original)
+++ activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/internal/io/StandardOutputStream.h Thu May 21 10:26:09 2009
@@ -84,65 +84,30 @@
public:
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void lock() throw( decaf::lang::Exception ){
mutex.lock();
}
- /**
- * Unlocks the object.
- * @throws Exception
- */
virtual void unlock() throw( decaf::lang::Exception ){
mutex.unlock();
}
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void wait() throw( decaf::lang::Exception ){
mutex.wait();
}
- /**
- * Waits on a signal from this object, which is generated
- * by a call to Notify. Must have this object locked before
- * calling. This wait will timeout after the specified time
- * interval.
- * @param time in milliseconds to wait, or WAIT_INIFINITE
- * @throws Exception
- */
virtual void wait( unsigned long millisecs ) throw( decaf::lang::Exception ){
mutex.wait( millisecs );
}
- /**
- * Signals a waiter on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notify() throw( decaf::lang::Exception ){
mutex.notify();
}
- /**
- * Signals the waiters on this object that it can now wake
- * up and continue. Must have this object locked before
- * calling.
- * @throws Exception
- */
virtual void notifyAll() throw( decaf::lang::Exception ){
mutex.notifyAll();
}
+
};
}}}