Changes between Version 15 and Version 16 of ariba_0_9

Timestamp:

Jun 21, 2013, 2:47:09 PM (11 years ago)

Author:

hock@…

Comment:

--

ariba_0_9

@@ -153 +153 @@
 
 Typical operations:
-  - reboost::message_t msg;  // creates an empty message
+  - reboost::message_t msg;
+    - creates an empty message
   - void message_t::push_back(shared_buffer_t)
   - void message_t::push_front(shared_buffer_t)
@@ -159 +160 @@
   - size_t message_t::size()
 
-For more information refer to the source code: ariba/utility/transport/messages/message.hpp
+For more information refer to the source code: `ariba/utility/transport/messages/message.hpp`
 
 ''' reboost::shared_buffer_t '''
+
+A simple shared buffer.
+
+Important: if not shared, a buffer is writable. After the buffer is shared, the buffer is immutable. It uses shared_ptr/default allocators and prints error messages to `cerr` if buffers leaked at the end of the program (only in `debug` mode).
+
+Typical operations:
+
+  - shared_buffer_t(size_t size)
+    - creates a shared buffer of a specific size
+    - allocates memory and frees after destruction
+  - shared_buffer_t(unsigned char* buffer, size_t size)
+    - creates a shared buffer from existing data
+    - transfers ownership
+    - frees memory after destruction
+  - shared_buffer_t shared_buffer_t::operator()(size_t index, size_t size = 0)
+    - return sub-buffer
+    - example: `shared_buffer_t sub_buff = buff(15)`;
+  - const uint8_t* data = buff.data();
+    - access data as array (read-only)
+  - uint8_t* data = buff.mutable_data();
+    - access data as array (writable)
+    - NOTE: only if buffer is not shared, yet
+
+For more information refer to the source code: `ariba/utility/transport/messages/shared_buffer.hpp`