- added and tested id_payload_t

[strongswan.git] / Source / charon / utils / iterator.h

diff --git a/Source/charon/utils/iterator.h b/Source/charon/utils/iterator.h
index 8a2a3c3..b27f3e7 100644 (file)
--- a/Source/charon/utils/iterator.h
+++ b/Source/charon/utils/iterator.h
@@ -49,10 +49,10 @@ struct iterator_t {
         * Returns the current value at the iterator position.
         * 
         * @param this                  calling object
-        * @param [out]value    value is set to the current value at iterator position
+        * @param[out] value    value is set to the current value at iterator position
         * @return
         *                                              - SUCCESS
-        *                                              - FAILED if list is empty
+        *                                              - FAILED if iterator on an invalid position
         */
        status_t (*current) (iterator_t *this, void **value);
        
@@ -62,25 +62,19 @@ struct iterator_t {
         * The iterator position is not changed after inserting
         * 
         * @param this                  calling iterator
-        * @param [in]item              value to insert in list
-        * @return 
-        *                                              - SUCCESS
-        *                                              - FAILED
+        * @param[in] item              value to insert in list
         */
-       status_t (*insert_before) (iterator_t *this, void *item);
+       void (*insert_before) (iterator_t *this, void *item);
 
        /**
-        * Inserts a new item after the given iterator position.
+        * @brief Inserts a new item after the given iterator position.
         * 
         * The iterator position is not changed after inserting.
         * 
         * @param this                  calling iterator
-        * @param [in]item              value to insert in list
-        * @return
-        *                                              - SUCCESS 
-        *                                              - FAILED
+        * @param[in] item              value to insert in list
         */
-       status_t (*insert_after) (iterator_t *this, void *item);
+       void (*insert_after) (iterator_t *this, void *item);
 
        /**
         * @brief removes an element from list at the given iterator position.
@@ -93,7 +87,7 @@ struct iterator_t {
         * @param linked_list   calling object
         * @return 
         *                                              - SUCCESS
-        *                                              - FAILED
+        *                                              - FAILED if iterator is on an invalid position
         */
        status_t (*remove) (iterator_t *iterator);
                          
@@ -105,18 +99,16 @@ struct iterator_t {
         * with the resetted iterator.
         * 
         * @param this                  calling object
-        * @return                              SUCCESS in any case
         */
-       status_t (*reset) (iterator_t *this);
+       void (*reset) (iterator_t *this);
 
        /**
         * @brief Destroys an iterator.
         * 
         * @param this                  iterator to destroy
-        * @return                              SUCCESS in any case
         * 
         */
-       status_t (*destroy) (iterator_t *this);
+       void (*destroy) (iterator_t *this);
 };
 
 #endif /*ITERATOR_H_*/