Sockets API
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/comm_callbacks.sgml:Title ##### -->
+comm_callbacks
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/comm_cb.sgml:Title ##### -->
+comm_cb
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Short_Description ##### -->
+Advanced ways to describe data (for experts)
+
+
+<!-- ##### SECTION ./tmpl/comm_datadesc_expert.sgml:Title ##### -->
+Advanced Data description
+
+
<!-- ##### SECTION ./tmpl/comm_dd_cbps.sgml:Long_Description ##### -->
<para>
Data description callbacks persistant state
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/dd_internal.sgml:Title ##### -->
+Implementation of data description
+
+
<!-- ##### SECTION ./tmpl/dico.sgml:Long_Description ##### -->
<para>
gras
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/gras_private.sgml:Title ##### -->
+gras_private
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Short_Description ##### -->
+Implementation of GRAS suited for real life.
+
+
+<!-- ##### SECTION ./tmpl/gras_rl.sgml:Title ##### -->
+RL
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Long_Description ##### -->
+<para>
+ SimGrid was designed to ease the comparison of algorithms and
+ heuristics. That way, a lot of complicated notion from the system layer
+ were volontary left off. For example, migrating a process from an host to
+ another is as easy as: MSG_process_change_host(process, new_host).
+</para>
+
+<para>
+ No need to tell that performing this operation on real platform is really
+ harder. This simplification is a very good thing when you want to rapidly
+ prototype code, but makes things somehow more complicated in GRAS since
+ we want to have a realistic API, since it have to be implemented in
+ reality also.
+</para>
+
+<para>
+ The best example of complexity in GRAS_SG induced by simplicity in
+ SimGrid is the sockets handling. There is no "socket" in SG, but only
+ m_channel_t. In contrary to sockets from RL, no special treatment is
+ needed for a process before writing or reading on/from a channel. So, a
+ given channel can be pooled by more than one process. Likewise, you can
+ send data to a channel that nobody is actually listening to.
+</para>
+
+<para>
+ The SG implementation of GRAS repport as an error the fact that nobody is
+ listening to the socket when trying to open a socket, or send stuff using
+ a previously openned socket. That way, the SG version can be used to
+ debug all syncronization issues. For that, we store mainly the PID of
+ both the sender and the receiver in the socket structure, and then
+ resolve PID->process at the lastest moment. This search is a bit
+ expensive, but as long as there is no real garbage collection in SG, with
+ the information "dead process" within the structure, it's the only
+ solution to make sure that we won't dereference pointers to an old freed
+ structure when the process on the other side of the structure did finish
+ since the creation of the socket.
+</para>
+
+<para>
+ As said in the overview, the processes can declare to hear on several
+ sockets, but all incoming messages are handled by the same loop. So, we
+ can use only one channel per process, and use a table on each host to
+ determine to which process a message should be delivered depending on the
+ socket number provided by the sender.
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:See_Also ##### -->
+<para>
+RL, the implementation suited for real life.
+</para>
+
+<!--
+Local variables:
+sgml-parent-document:\.\./gras-docs\.sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-namecase-general:t
+sgml-general-insert-case:lower
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Short_Description ##### -->
+Implementation of GRAS on top of the simulator.
+
+
+<!-- ##### SECTION ./tmpl/gras_sg.sgml:Title ##### -->
+SG
+
+
<!-- ##### SECTION ./tmpl/nws_comm.sgml:Long_Description ##### -->
<para>
@a4:
@a5:
+<!-- ##### MACRO CCRITICAL6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### MACRO CDEBUG0 ##### -->
<para>
@a4:
@a5:
+<!-- ##### MACRO CDEBUG6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### MACRO CERROR0 ##### -->
<para>
@a4:
@a5:
+<!-- ##### MACRO CERROR6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### MACRO CINFO0 ##### -->
<para>
@a4:
@a5:
+<!-- ##### MACRO CINFO6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### MACRO CLOG0 ##### -->
<para>
@a4:
@a5:
+<!-- ##### MACRO CRITICAL6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
+<!-- ##### MACRO CVERB6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
+<!-- ##### MACRO CWARN6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
+<!-- ##### MACRO CWARNING6 ##### -->
+<para>
+
+</para>
+
+@c:
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### FUNCTION CallAddr ##### -->
<para>
@waitForPeer:
@Returns:
+<!-- ##### FUNCTION ConvertData ##### -->
+<para>
+
+</para>
+
+@destination:
+@source:
+@description:
+@length:
+@sourceFormat:
+
<!-- ##### FUNCTION CreateLocalChild ##### -->
<para>
@childToParent:
@Returns:
+<!-- ##### MACRO DEBUG6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### FUNCTION DROP_SOCKET ##### -->
<para>
@STRUCT_TYPE:
@LAST_TYPE:
-<!-- ##### MACRO END_DECL ##### -->
+<!-- ##### FUNCTION DifferentFormat ##### -->
<para>
</para>
+@whatType:
+@Returns:
-<!-- ##### MACRO EODD ##### -->
+<!-- ##### FUNCTION DifferentOrder ##### -->
<para>
</para>
+@Returns:
-<!-- ##### FUNCTION EstablishAnEar ##### -->
+<!-- ##### FUNCTION DifferentSize ##### -->
<para>
</para>
-@Param1:
-@Param2:
-@ear:
-@earPort:
+@whatType:
@Returns:
-<!-- ##### ENUM FormatTypes ##### -->
+<!-- ##### MACRO END_DECL ##### -->
<para>
</para>
-@HOST_FORMAT:
-@NETWORK_FORMAT:
-<!-- ##### MACRO GRAS_LOG_MAYDAY ##### -->
+<!-- ##### MACRO EODD ##### -->
<para>
</para>
-<!-- ##### MACRO GRAS_LOG_ROOT_CAT ##### -->
+<!-- ##### MACRO ERROR6 ##### -->
<para>
</para>
-
-<!-- ##### MACRO HAVE_DLFCN_H ##### -->
-<para>
-
-</para>
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
+<!-- ##### FUNCTION EstablishAnEar ##### -->
+<para>
+
+</para>
+
+@Param1:
+@Param2:
+@ear:
+@earPort:
+@Returns:
+
+<!-- ##### ENUM FormatTypes ##### -->
+<para>
+
+</para>
+
+@HOST_FORMAT:
+@NETWORK_FORMAT:
+
+<!-- ##### MACRO GRAS_DEFINE_TYPE ##### -->
+<para>
+
+</para>
+
+@name:
+@def:
+
+<!-- ##### MACRO GRAS_LOG_DEFAULT_CATEGORY ##### -->
+<para>
+
+</para>
+
+@cname:
+
+<!-- ##### MACRO GRAS_LOG_EXTERNAL_CATEGORY ##### -->
+<para>
+
+</para>
+
+@cname:
+
+<!-- ##### MACRO GRAS_LOG_ISENABLED ##### -->
+<para>
+
+</para>
+
+@catName:
+@priority:
+
+<!-- ##### MACRO GRAS_LOG_MAYDAY ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO GRAS_LOG_NEW_CATEGORY ##### -->
+<para>
+
+</para>
+
+@catName:
+
+<!-- ##### MACRO GRAS_LOG_NEW_DEFAULT_CATEGORY ##### -->
+<para>
+
+</para>
+
+@cname:
+
+<!-- ##### MACRO GRAS_LOG_NEW_DEFAULT_SUBCATEGORY ##### -->
+<para>
+
+</para>
+
+@cname:
+@parent:
+
+<!-- ##### MACRO GRAS_LOG_NEW_SUBCATEGORY ##### -->
+<para>
+
+</para>
+
+@catName:
+@parent:
+
+<!-- ##### MACRO GRAS_LOG_ROOT_CAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO GRAS_LOG_STATIC_THRESHOLD ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO HAVE_DLFCN_H ##### -->
+<para>
+
+</para>
<!-- ##### MACRO HAVE_INTTYPES_H ##### -->
</para>
+<!-- ##### FUNCTION HomogenousConvertData ##### -->
+<para>
+
+</para>
+
+@destination:
+@source:
+@whatType:
+@repetitions:
+@sourceFormat:
+
+<!-- ##### FUNCTION HomogenousDataSize ##### -->
+<para>
+
+</para>
+
+@whatType:
+@repetitions:
+@format:
+@Returns:
+
+<!-- ##### MACRO INFO6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### TYPEDEF IPAddress ##### -->
<para>
@sd:
@Returns:
+<!-- ##### FUNCTION ReverseData ##### -->
+<para>
+
+</para>
+
+@destination:
+@source:
+@whatType:
+@repetitions:
+@format:
+
<!-- ##### MACRO SIMPLE_DATA ##### -->
<para>
@repetitions:
@offset:
+<!-- ##### MACRO SIMPLE_TYPE_COUNT ##### -->
+<para>
+
+</para>
+
+
<!-- ##### MACRO STDC_HEADERS ##### -->
<para>
@sd:
@Returns:
+<!-- ##### MACRO VERB6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### MACRO VERSION ##### -->
<para>
</para>
+<!-- ##### MACRO WARN6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
+<!-- ##### MACRO WARNING6 ##### -->
+<para>
+
+</para>
+
+@f:
+@a1:
+@a2:
+@a3:
+@a4:
+@a5:
+@a6:
+
<!-- ##### USER_FUNCTION grasCallbackFunction ##### -->
<para>
@Varargs:
@Returns:
+<!-- ##### FUNCTION grasMsgRecv ##### -->
+<para>
+
+</para>
+
+@msg:
+@timeout:
+@Returns:
+@sd:
+
<!-- ##### FUNCTION grasMsgRegister ##### -->
<para>
@ud:
-<!-- ##### FUNCTION gras_datadesc_cmp ##### -->
+<!-- ##### FUNCTION gras_arch_selfid ##### -->
<para>
</para>
-@d1:
-@d2:
@Returns:
-@dd1:
-@c1:
-@dd2:
-@c2:
-<!-- ##### FUNCTION gras_datadesc_copy_data ##### -->
+<!-- ##### FUNCTION gras_cb_register ##### -->
<para>
</para>
-@dd:
-@c:
-@data:
+@msgtype:
+@cb:
+@Returns:
+@message:
+@TTL:
-<!-- ##### FUNCTION gras_dict_cursor_next ##### -->
+<!-- ##### USER_FUNCTION gras_cb_t ##### -->
<para>
</para>
-@cursor:
+@expeditor:
+@payload:
@Returns:
+@payload_type:
+@payload_data:
+@msg:
-<!-- ##### FUNCTION gras_dynar_first ##### -->
+<!-- ##### FUNCTION gras_cb_unregister ##### -->
<para>
</para>
-@dynar:
-@cursor:
-@Returns:
+@msgtype:
+@cb:
-<!-- ##### FUNCTION gras_dynar_next ##### -->
+<!-- ##### FUNCTION gras_cbps_block_begin ##### -->
<para>
</para>
-@dynar:
-@cursor:
-@whereto:
-@Returns:
+@ps:
-<!-- ##### FUNCTION gras_lock ##### -->
+<!-- ##### FUNCTION gras_cbps_block_end ##### -->
+<para>
+
+</para>
+
+@ps:
+
+<!-- ##### FUNCTION gras_cbps_i_pop ##### -->
<para>
</para>
+@ps:
@Returns:
-<!-- ##### FUNCTION gras_log_parent_set ##### -->
+<!-- ##### FUNCTION gras_cbps_i_push ##### -->
<para>
</para>
-@cat:
-@parent:
+@ps:
+@val:
-<!-- ##### FUNCTION gras_log_threshold_set ##### -->
+<!-- ##### FUNCTION gras_cbps_v_get ##### -->
<para>
</para>
-@cat:
-@thresholdPriority:
+@ps:
+@name:
+@ddt:
-<!-- ##### FUNCTION gras_sock_client_open ##### -->
+<!-- ##### FUNCTION gras_cbps_v_pop ##### -->
<para>
</para>
-@host:
-@Param2:
-@sock:
+@ps:
+@name:
+@ddt:
+@res:
@Returns:
-<!-- ##### FUNCTION gras_sock_close ##### -->
+<!-- ##### FUNCTION gras_cbps_v_push ##### -->
<para>
</para>
-@sock:
+@ps:
+@name:
+@data:
+@ddt:
@Returns:
-<!-- ##### FUNCTION gras_sock_get_peer_addr ##### -->
+<!-- ##### FUNCTION gras_cbps_v_set ##### -->
<para>
</para>
-@sd:
-@Returns:
+@ps:
+@name:
+@data:
+@ddt:
-<!-- ##### FUNCTION gras_sock_get_peer_name ##### -->
+<!-- ##### FUNCTION gras_cfg_check ##### -->
<para>
</para>
-@sd:
+@cfg:
@Returns:
-<!-- ##### FUNCTION gras_sock_server_open ##### -->
+<!-- ##### FUNCTION gras_cfg_cpy ##### -->
<para>
</para>
-@Param1:
-@Param2:
-@sock:
+@whereto:
+@tocopy:
@Returns:
-<!-- ##### FUNCTION gras_socket_peer_name ##### -->
+<!-- ##### FUNCTION gras_cfg_dump ##### -->
<para>
</para>
-@sd:
+@name:
+@indent:
+@cfg:
+
+<!-- ##### FUNCTION gras_cfg_empty ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
@Returns:
-<!-- ##### FUNCTION gras_unlock ##### -->
+<!-- ##### FUNCTION gras_cfg_free ##### -->
+<para>
+
+</para>
+
+@cfg:
+
+<!-- ##### FUNCTION gras_cfg_get_double ##### -->
<para>
</para>
+@cfg:
+@name:
+@val:
@Returns:
+<!-- ##### FUNCTION gras_cfg_get_dynar ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@dynar:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_get_host ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@host:
+@port:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_get_int ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_get_string ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_new ##### -->
+<para>
+
+</para>
+
+@whereto:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_register ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@type:
+@min:
+@max:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_register_str ##### -->
+<para>
+
+</para>
+
+@cfg:
+@entry:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_rm_double ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_rm_host ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@host:
+@port:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_rm_int ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_rm_string ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set ##### -->
+<para>
+
+</para>
+
+@cfg:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_double ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_host ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@host:
+@port:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_int ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_parse ##### -->
+<para>
+
+</para>
+
+@cfg:
+@options:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_string ##### -->
+<para>
+
+</para>
+
+@cfg:
+@name:
+@val:
+@Returns:
+
+<!-- ##### FUNCTION gras_cfg_set_vargs ##### -->
+<para>
+
+</para>
+
+@cfg:
+@pa:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_array_dyn ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@dynamic_size:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_array_fixed ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@fixed_size:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_by_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+@type:
+
+<!-- ##### MACRO gras_datadesc_by_symbol ##### -->
+<para>
+
+</para>
+
+@name:
+
+<!-- ##### FUNCTION gras_datadesc_cb_recv ##### -->
+<para>
+
+</para>
+
+@type:
+@post:
+
+<!-- ##### FUNCTION gras_datadesc_cb_send ##### -->
+<para>
+
+</para>
+
+@type:
+@pre:
+
+<!-- ##### FUNCTION gras_datadesc_cb_set_post ##### -->
+<para>
+
+</para>
+
+@type:
+@post:
+
+<!-- ##### FUNCTION gras_datadesc_cb_set_pre ##### -->
+<para>
+
+</para>
+
+@type:
+@pre:
+
+<!-- ##### FUNCTION gras_datadesc_cmp ##### -->
+<para>
+
+</para>
+
+@d1:
+@d2:
+@Returns:
+@dd1:
+@c1:
+@dd2:
+@c2:
+
+<!-- ##### FUNCTION gras_datadesc_copy_data ##### -->
+<para>
+
+</para>
+
+@dd:
+@c:
+@data:
+
+<!-- ##### MACRO gras_datadesc_declare_array ##### -->
+<para>
+
+</para>
+
+@name:
+@elm_type:
+@size:
+@code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_array_cb ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@fixed_size:
+@dynamic_size:
+@post:
+@code:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_array_dyn ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@dynamic_size:
+@dst:
+@Returns:
+@elm_type:
+@code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_array_fixed ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@fixed_size:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_ref ##### -->
+<para>
+
+</para>
+
+@name:
+@referenced_type:
+@dst:
+@Returns:
+@ref_type:
+@code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_ref_cb ##### -->
+<para>
+
+</para>
+
+@name:
+@referenced_type:
+@discriminant:
+@post:
+@code:
+@Returns:
+
+<!-- ##### MACRO gras_datadesc_declare_ref_disc ##### -->
+<para>
+
+</para>
+
+@name:
+@discriminant:
+@code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_ref_generic ##### -->
+<para>
+
+</para>
+
+@name:
+@discriminant:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct ##### -->
+<para>
+
+</para>
+
+@name:
+@dst:
+@Returns:
+@code:
+
+<!-- ##### MACRO gras_datadesc_declare_struct_add_code ##### -->
+<para>
+
+</para>
+
+@struct_code:
+@field_name:
+@field_type_code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_add_code_cb ##### -->
+<para>
+
+</para>
+
+@struct_code:
+@field_name:
+@field_code:
+@pre_cb:
+@post_cb:
+@Returns:
+
+<!-- ##### MACRO gras_datadesc_declare_struct_add_name ##### -->
+<para>
+
+</para>
+
+@struct_code:
+@field_name:
+@field_type_name:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_add_name_cb ##### -->
+<para>
+
+</para>
+
+@struct_code:
+@field_name:
+@field_type_name:
+@pre_cb:
+@post_cb:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_append ##### -->
+<para>
+
+</para>
+
+@struct_type:
+@name:
+@field_type:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_append_name ##### -->
+<para>
+
+</para>
+
+@struct_type:
+@name:
+@field_type_name:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_cb ##### -->
+<para>
+
+</para>
+
+@name:
+@pre_cb:
+@post_cb:
+@code:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_struct_close ##### -->
+<para>
+
+</para>
+
+@struct_type:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union ##### -->
+<para>
+
+</para>
+
+@name:
+@selector:
+@dst:
+@Returns:
+@code:
+
+<!-- ##### MACRO gras_datadesc_declare_union_add_code ##### -->
+<para>
+
+</para>
+
+@union_code:
+@field_name:
+@field_type_code:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_add_code_cb ##### -->
+<para>
+
+</para>
+
+@union_code:
+@field_name:
+@field_code:
+@pre_cb:
+@post_cb:
+@Returns:
+
+<!-- ##### MACRO gras_datadesc_declare_union_add_name ##### -->
+<para>
+
+</para>
+
+@union_code:
+@field_name:
+@field_type_name:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_add_name_cb ##### -->
+<para>
+
+</para>
+
+@union_code:
+@field_name:
+@field_type_name:
+@pre_cb:
+@post_cb:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_append ##### -->
+<para>
+
+</para>
+
+@union_type:
+@name:
+@field_type:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_append_name ##### -->
+<para>
+
+</para>
+
+@union_type:
+@name:
+@field_type_name:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_cb ##### -->
+<para>
+
+</para>
+
+@name:
+@field_count:
+@post:
+@code:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_declare_union_close ##### -->
+<para>
+
+</para>
+
+@union_type:
+
+<!-- ##### FUNCTION gras_datadesc_from_nws ##### -->
+<para>
+
+</para>
+
+@name:
+@desc:
+@howmany:
+@code:
+@Returns:
+@dst:
+
+<!-- ##### FUNCTION gras_datadesc_import_nws ##### -->
+<para>
+
+</para>
+
+@name:
+@desc:
+@howmany:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_parse ##### -->
+<para>
+
+</para>
+
+@name:
+@Cdefinition:
+@dst:
+@Returns:
+@code:
+@def:
+
+<!-- ##### FUNCTION gras_datadesc_ref ##### -->
+<para>
+
+</para>
+
+@name:
+@referenced_type:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_ref_generic ##### -->
+<para>
+
+</para>
+
+@name:
+@selector:
+@dst:
+@Returns:
+@discriminant:
+
+<!-- ##### FUNCTION gras_datadesc_ref_pop_arr ##### -->
+<para>
+
+</para>
+
+@element_type:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_struct ##### -->
+<para>
+
+</para>
+
+@name:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_struct_append ##### -->
+<para>
+
+</para>
+
+@struct_type:
+@name:
+@field_type:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_struct_close ##### -->
+<para>
+
+</para>
+
+@struct_type:
+
+<!-- ##### USER_FUNCTION gras_datadesc_type_cb_int_t ##### -->
+<para>
+
+</para>
+
+@vars:
+@data:
+@Returns:
+@p_type:
+
+<!-- ##### USER_FUNCTION gras_datadesc_type_cb_void_t ##### -->
+<para>
+
+</para>
+
+@vars:
+@data:
+@p_type:
+
+<!-- ##### FUNCTION gras_datadesc_union ##### -->
+<para>
+
+</para>
+
+@name:
+@selector:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_union_append ##### -->
+<para>
+
+</para>
+
+@union_type:
+@name:
+@field_type:
+@Returns:
+
+<!-- ##### FUNCTION gras_datadesc_union_close ##### -->
+<para>
+
+</para>
+
+@union_type:
+
+<!-- ##### FUNCTION gras_dd_cbps_block_begin ##### -->
+<para>
+
+</para>
+
+@ps:
+
+<!-- ##### FUNCTION gras_dd_cbps_block_end ##### -->
+<para>
+
+</para>
+
+@ps:
+
+<!-- ##### FUNCTION gras_dd_cbps_get ##### -->
+<para>
+
+</para>
+
+@ps:
+@name:
+@ddt:
+
+<!-- ##### FUNCTION gras_dd_cbps_pop ##### -->
+<para>
+
+</para>
+
+@ps:
+@name:
+@ddt:
+
+<!-- ##### FUNCTION gras_dd_cbps_push ##### -->
+<para>
+
+</para>
+
+@ps:
+@name:
+@data:
+@ddt:
+
+<!-- ##### FUNCTION gras_dd_cbps_set ##### -->
+<para>
+
+</para>
+
+@ps:
+@name:
+@data:
+@ddt:
+
+<!-- ##### FUNCTION gras_ddt_free ##### -->
+<para>
+
+</para>
+
+@type:
+
+<!-- ##### FUNCTION gras_ddt_get_by_code ##### -->
+<para>
+
+</para>
+
+@code:
+@type:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_get_by_name ##### -->
+<para>
+
+</para>
+
+@name:
+@type:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_array ##### -->
+<para>
+
+</para>
+
+@name:
+@element_type:
+@fixed_size:
+@dynamic_size:
+@post:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_from_nws ##### -->
+<para>
+
+</para>
+
+@name:
+@desc:
+@howmany:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_ignored ##### -->
+<para>
+
+</para>
+
+@name:
+@default_value:
+@free_func:
+@size:
+@alignment:
+@post:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_parse ##### -->
+<para>
+
+</para>
+
+@name:
+@C_definition:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_ref ##### -->
+<para>
+
+</para>
+
+@name:
+@referenced_type:
+@discriminant:
+@post:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_scalar ##### -->
+<para>
+
+</para>
+
+@name:
+@type:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_struct ##### -->
+<para>
+
+</para>
+
+@name:
+@pre:
+@post:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_struct_append ##### -->
+<para>
+
+</para>
+
+@struct_type:
+@name:
+@field_type:
+@pre:
+@post:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_union ##### -->
+<para>
+
+</para>
+
+@name:
+@field_count:
+@post:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_new_union_append ##### -->
+<para>
+
+</para>
+
+@union_type:
+@name:
+@field_type:
+@pre:
+@post:
+@Returns:
+
+<!-- ##### FUNCTION gras_ddt_register ##### -->
+<para>
+
+</para>
+
+@type:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_free ##### -->
+<para>
+
+</para>
+
+@cursor:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_get_data ##### -->
+<para>
+
+</para>
+
+@cursor:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_get_key ##### -->
+<para>
+
+</para>
+
+@cursor:
+@key:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_new ##### -->
+<para>
+
+</para>
+
+@head:
+@cursor:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_next ##### -->
+<para>
+
+</para>
+
+@cursor:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_cursor_rewind ##### -->
+<para>
+
+</para>
+
+@cursor:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_dump ##### -->
+<para>
+
+</para>
+
+@head:
+@output:
+@Returns:
+
+<!-- ##### MACRO gras_dict_foreach ##### -->
+<para>
+
+</para>
+
+@dict:
+@cursor:
+@key:
+@data:
+
+<!-- ##### FUNCTION gras_dict_free ##### -->
+<para>
+
+</para>
+
+@dict:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_get ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_get_ext ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@key_len:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_insert ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@data:
+@free_ctn:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_insert_ext ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@key_len:
+@data:
+@free_ctn:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_new ##### -->
+<para>
+
+</para>
+
+@dict:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_print ##### -->
+<para>
+
+</para>
+
+@data:
+
+<!-- ##### FUNCTION gras_dict_prints ##### -->
+<para>
+
+</para>
+
+@data:
+
+<!-- ##### FUNCTION gras_dict_remove ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_remove_ext ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@key_len:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_retrieve ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_retrieve_ext ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@key_len:
+@data:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_set ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@data:
+@free_ctn:
+@Returns:
+
+<!-- ##### FUNCTION gras_dict_set_ext ##### -->
+<para>
+
+</para>
+
+@head:
+@key:
+@key_len:
+@data:
+@free_ctn:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_cursor_first ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+
+<!-- ##### FUNCTION gras_dynar_cursor_get ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+@whereto:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_cursor_rm ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+
+<!-- ##### FUNCTION gras_dynar_cursor_step ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+
+<!-- ##### FUNCTION gras_dynar_first ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+@Returns:
+
+<!-- ##### MACRO gras_dynar_foreach ##### -->
+<para>
+
+</para>
+
+@_dynar:
+@_cursor:
+@_data:
+@_whereto:
+
+<!-- ##### FUNCTION gras_dynar_free ##### -->
+<para>
+
+</para>
+
+@dynar:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_free_container ##### -->
+<para>
+
+</para>
+
+@dynar:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_get ##### -->
+<para>
+
+</para>
+
+@dynar:
+@idx:
+@dst:
+@whereto:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_insert_at ##### -->
+<para>
+
+</para>
+
+@dynar:
+@idx:
+@src:
+@Returns:
+@object:
+
+<!-- ##### FUNCTION gras_dynar_length ##### -->
+<para>
+
+</para>
+
+@dynar:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_map ##### -->
+<para>
+
+</para>
+
+@dynar:
+@operator:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_new ##### -->
+<para>
+
+</para>
+
+@whereto:
+@elm_size:
+@free_func:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_next ##### -->
+<para>
+
+</para>
+
+@dynar:
+@cursor:
+@whereto:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_pop ##### -->
+<para>
+
+</para>
+
+@dynar:
+@dst:
+@whereto:
+
+<!-- ##### FUNCTION gras_dynar_push ##### -->
+<para>
+
+</para>
+
+@dynar:
+@src:
+@Returns:
+@object:
+
+<!-- ##### FUNCTION gras_dynar_remove_at ##### -->
+<para>
+
+</para>
+
+@dynar:
+@idx:
+@object:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_remplace ##### -->
+<para>
+
+</para>
+
+@dynar:
+@idx:
+@object:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_reset ##### -->
+<para>
+
+</para>
+
+@dynar:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_set ##### -->
+<para>
+
+</para>
+
+@dynar:
+@idx:
+@src:
+@Returns:
+@object:
+
+<!-- ##### FUNCTION gras_dynar_shift ##### -->
+<para>
+
+</para>
+
+@dynar:
+@dst:
+@whereto:
+@Returns:
+
+<!-- ##### FUNCTION gras_dynar_unshift ##### -->
+<para>
+
+</para>
+
+@dynar:
+@src:
+@Returns:
+@object:
+
+<!-- ##### ENUM gras_error_t ##### -->
+<para>
+
+</para>
+
+@no_error: no error
+@malloc_error: Well known error
+@mismatch_error: Not found
+@system_error: a syscall did fail
+@network_error: error while sending/receiving data
+@timeout_error: not quick enough, dude
+@thread_error: error while [un]locking
+@unknown_error: no idea
+
+<!-- ##### FUNCTION gras_lock ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION gras_log_appender_set ##### -->
+<para>
+
+</para>
+
+@cat:
+@app:
+
+<!-- ##### FUNCTION gras_log_control_set ##### -->
+<para>
+
+</para>
+
+@cs:
+@Returns:
+
+<!-- ##### VARIABLE gras_log_default_appender ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gras_log_parent_set ##### -->
+<para>
+
+</para>
+
+@cat:
+@parent:
+
+<!-- ##### ENUM gras_log_priority_t ##### -->
+<para>
+
+</para>
+
+@gras_log_priority_none:
+@gras_log_priority_trace:
+@gras_log_priority_debug:
+@gras_log_priority_verbose:
+@gras_log_priority_info:
+@gras_log_priority_warning:
+@gras_log_priority_error:
+@gras_log_priority_critical:
+@gras_log_priority_infinite:
+@gras_log_priority_uninitialized:
+
+<!-- ##### FUNCTION gras_log_threshold_set ##### -->
+<para>
+
+</para>
+
+@cat:
+@thresholdPriority:
+
+<!-- ##### FUNCTION gras_msg_discard ##### -->
+<para>
+
+</para>
+
+@sd:
+@size:
+
+<!-- ##### FUNCTION gras_msg_free ##### -->
+<para>
+
+</para>
+
+@msg:
+
+<!-- ##### FUNCTION gras_msg_handle ##### -->
+<para>
+
+</para>
+
+@timeOut:
+@Returns:
+
+<!-- ##### FUNCTION gras_msg_new ##### -->
+<para>
+
+</para>
+
+@msgId:
+@free_data_on_free:
+@seqCount:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gras_msg_send ##### -->
+<para>
+
+</para>
+
+@sock:
+@msgtype:
+@payload:
+@Returns:
+@sd:
+@msg:
+@freeDirective:
+
+<!-- ##### FUNCTION gras_msg_wait ##### -->
+<para>
+
+</para>
+
+@timeout:
+@msgt_want:
+@expeditor:
+@payload:
+@Returns:
+@id:
+@message:
+
+<!-- ##### FUNCTION gras_msgtype_by_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+@dst:
+
+<!-- ##### FUNCTION gras_msgtype_by_namev ##### -->
+<para>
+
+</para>
+
+@name:
+@version:
+@Returns:
+@dst:
+
+<!-- ##### FUNCTION gras_msgtype_declare ##### -->
+<para>
+
+</para>
+
+@name:
+@payload:
+@Returns:
+@dst:
+
+<!-- ##### FUNCTION gras_msgtype_declare_v ##### -->
+<para>
+
+</para>
+
+@name:
+@version:
+@payload:
+@Returns:
+@dst:
+
+<!-- ##### FUNCTION gras_msgtype_register ##### -->
+<para>
+
+</para>
+
+@msgId:
+@name:
+@sequence_count:
+@Varargs:
+@Returns:
+
+<!-- ##### FUNCTION gras_os_sleep ##### -->
+<para>
+
+</para>
+
+@Param1:
+@Param2:
+
+<!-- ##### FUNCTION gras_os_time ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION gras_set_add ##### -->
+<para>
+
+</para>
+
+@set:
+@elm:
+@free_func:
+@Returns:
+
+<!-- ##### MACRO gras_set_foreach ##### -->
+<para>
+
+</para>
+
+@set:
+@cursor:
+@elm:
+
+<!-- ##### FUNCTION gras_set_free ##### -->
+<para>
+
+</para>
+
+@set:
+
+<!-- ##### FUNCTION gras_set_get_by_id ##### -->
+<para>
+
+</para>
+
+@set:
+@id:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_set_get_by_name ##### -->
+<para>
+
+</para>
+
+@set:
+@key:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_set_get_by_name_ext ##### -->
+<para>
+
+</para>
+
+@set:
+@name:
+@name_len:
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_set_new ##### -->
+<para>
+
+</para>
+
+@dst:
+@Returns:
+
+<!-- ##### FUNCTION gras_sleep ##### -->
+<para>
+
+</para>
+
+@Param1:
+@Param2:
+
+<!-- ##### FUNCTION gras_sock_client_open ##### -->
+<para>
+
+</para>
+
+@host:
+@Param2:
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_sock_close ##### -->
+<para>
+
+</para>
+
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_sock_get_peer_addr ##### -->
+<para>
+
+</para>
+
+@sd:
+@Returns:
+
+<!-- ##### FUNCTION gras_sock_get_peer_name ##### -->
+<para>
+
+</para>
+
+@sd:
+@Returns:
+
+<!-- ##### FUNCTION gras_sock_server_open ##### -->
+<para>
+
+</para>
+
+@Param1:
+@Param2:
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_socket_client ##### -->
+<para>
+
+</para>
+
+@host:
+@Param2:
+@dst:
+@Returns:
+@bufSize:
+@sock:
+
+<!-- ##### FUNCTION gras_socket_close ##### -->
+<para>
+
+</para>
+
+@sd:
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_socket_my_port ##### -->
+<para>
+
+</para>
+
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_socket_peer_name ##### -->
+<para>
+
+</para>
+
+@sock:
+@Returns:
+@sd:
+
+<!-- ##### FUNCTION gras_socket_peer_port ##### -->
+<para>
+
+</para>
+
+@sock:
+@Returns:
+
+<!-- ##### FUNCTION gras_socket_server ##### -->
+<para>
+
+</para>
+
+@Param1:
+@dst:
+@Returns:
+@bufSize:
+
+<!-- ##### FUNCTION gras_time ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION gras_unlock ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+<!-- ##### FUNCTION gras_userdata_get ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO gras_userdata_new ##### -->
+<para>
+
+</para>
+
+@type:
+
+<!-- ##### FUNCTION gras_userdata_set ##### -->
+<para>
+
+</para>
+
+@ud:
+
