Changes between Version 3 and Version 4 of C++ API

Timestamp:

09/10/12 11:19:57 (12 years ago)

Author:

jorisborgdorff

Comment:

--

C++ API

@@ -30 +30 @@
 
 The send and receive functions can transport several datatypes, which are enumerated in {{{muscle2/muscle_types.h}}}. For reference, it takes the following datatypes
-||={{{muscle_datatype_t}}}=||=C data type=||= Java data type =||=maximum size=||
+||={{{muscle_datatype_t}}}=||=C/C++ data type=||= Java data type =||=maximum size=||
 ||{{{MUSCLE_DOUBLE}}}||{{{double *}}}||{{{double[]}}}||134e6 values ||
 ||{{{MUSCLE_FLOAT}}}||{{{float *}}}||{{{float[]}}}||268e6 values||
@@ -41 +41 @@
 The type {{{MUSCLE_COMPLEX}}} is only available for C++ code.
 
-Receiving a message can be done in two ways: either the memory is initialized beforehand and the buffer size is given as the third argument, or a 0 pointer is passed, in which case MUSCLE will initialize the memory. In both cases, the memory must be freed by the user. For example:
+Receiving a message can be done in two ways: either the memory is initialized beforehand and the buffer size is given as the third argument, or a 0 pointer is passed, in which case MUSCLE will allocate the memory. In both cases, the memory must be freed by the user. For example:
 {{{
 size_t sz = 100;
@@ -48 +48 @@
     for (int i = 0; !MUSCLE_Will_Stop(); i++) {
         MUSCLE_Receive("exitName", data, &sz, MUSCLE_DOUBLE);
+        // sz will be set to the actual size of the received message
         // do something with the data
     }
@@ -63 +64 @@
 }
 }}}
+The first example will only work if you know the upper bound of received message size in advance. In this way, memory is only allocated once per submodel run. The second example is safer since MUSCLE will allocate the necessary data for you based on the message size. It does mean that new memory is allocated each message.
+
+The {{{MUSCLE_Send}}} command can only be used one way.
+{{{
+double data[100];
+size_t sz = 100;
+for (int i = 0; !MUSCLE_Will_Stop(); i++) {
+    // do something with the data...
+    // send the data
+    MUSCLE_Send("entranceName", data, sz, MUSCLE_DOUBLE);
+}
+// data is on the stack; it will be freed automatically
+}}}
+
+== C++ API ==
+
+