src/framework/event/util.h

   1 /*
   2  * sync-agent
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef EVENT_UTIL_H_
  19 #define EVENT_UTIL_H_
  20
  21 #include "event/data_accessor.h"
  22
  23 /**
  24  * @file                Event_Util.h
  25  * @brief       Event module Internal Utility function set
  26  */
  27
  28 /** @addtogroup event
  29  *      @{
  30  */
  31
  32 /**
  33  * @brief       Initialization sync_agent_event_data_s structure
  34  * @remarks     Member variable size, data will be initialized
  35  * @param[in] event Initialization data
  36  */
  37 void event_init_event_data_iter(sync_agent_event_data_s * event);
  38
  39 /**
  40  * @brief Get byte size of event stream
  41  * @param[in] iter Event structure
  42  * @return byte size
  43  */
  44 int event_get_event_data_byte_size(sync_agent_event_data_s * iter);
  45
  46 /**
  47  * @brief Get element size of current iterator
  48  * @param[in] iter Event structure
  49  * @return byte size
  50  */
  51 int event_get_event_data_element_size(sync_agent_event_data_s * iter);
  52
  53 /**
  54  * @brief       Free buffer of Event structure, not Event Structure
  55  * @param[in] event Event structure
  56  */
  57 void event_remove_buffer(sync_agent_event_data_s * event);
  58
  59 /**
  60  *      @}
  61  */
  62
  63 #endif                          /* EVENT_UTIL_H_ */