URL
https://opencores.org/ocsvn/funbase_ip_library/funbase_ip_library/trunk
Subversion Repositories funbase_ip_library
[/] [funbase_ip_library/] [trunk/] [TUT/] [ip.swp.api/] [mcapi_transport/] [1.0/] [mcapi_transport.1.0.xml] - Rev 145
Compare with Previous | Blame | View Log
<?xml version="1.0" encoding="UTF-8"?>
<!-- Created by Kactus2 - Open source IP-Xact toolset -->
<!-- http://sourceforge.net/projects/kactus2/ -->
<!-- Date: 03.07.2012 -->
<!-- Time: 12:28:21 -->
<kactus2:apiDefinition>
<spirit:vendor>TUT</spirit:vendor>
<spirit:library>ip.swp.api</spirit:library>
<spirit:name>mcapi_transport</spirit:name>
<spirit:version>1.0</spirit:version>
<kactus2:comDefinitionRef spirit:vendor="" spirit:library="" spirit:name="" spirit:version=""/>
<kactus2:dataTypes>
<kactus2:dataType kactus2:name="mcapi_int_t"/>
<kactus2:dataType kactus2:name="mcapi_uint_t"/>
<kactus2:dataType kactus2:name="mcapi_uint8_t"/>
<kactus2:dataType kactus2:name="mcapi_uint16_t"/>
<kactus2:dataType kactus2:name="mcapi_uint32_t"/>
<kactus2:dataType kactus2:name="mcapi_uint64_t"/>
<kactus2:dataType kactus2:name="mcapi_boolean_t"/>
<kactus2:dataType kactus2:name="mcapi_endpoint_t"/>
<kactus2:dataType kactus2:name="mcapi_node_t"/>
<kactus2:dataType kactus2:name="mcapi_port_t"/>
<kactus2:dataType kactus2:name="mcapi_version_t"/>
<kactus2:dataType kactus2:name="mcapi_status_t"/>
<kactus2:dataType kactus2:name="mcapi_request_t"/>
<kactus2:dataType kactus2:name="mcapi_priority_t"/>
<kactus2:dataType kactus2:name="mcapi_timeout_t"/>
<kactus2:dataType kactus2:name="mcapi_pktchan_recv_hndl_t"/>
<kactus2:dataType kactus2:name="mcapi_pktchan_send_hndl_t"/>
<kactus2:dataType kactus2:name="mcapi_sclchan_recv_hndl_t"/>
<kactus2:dataType kactus2:name="mcapi_sclchan_send_hndl_t"/>
</kactus2:dataTypes>
<kactus2:functions>
<kactus2:function kactus2:name="mcapi_initialize" kactus2:description="Initializes the MCAPI implementation.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="node_id" kactus2:type="mcapi_node_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Unique node identifier."/>
<kactus2:functionParameter kactus2:name="mcapi_version" kactus2:type="mcapi_version_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The used MCAPI version."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_finalize" kactus2:description="Finalizes the MCAPI implementation.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_get_node_id" kactus2:description="Returns the node number associated with the local node.">
<kactus2:returnValue kactus2:type="mcapi_uint_t" kactus2:description="The node id associated with the local node."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_create_endpoint" kactus2:description="Creates an endpoint.">
<kactus2:returnValue kactus2:type="mcapi_endpoint_t" kactus2:description="The created endpoint, if successfull. MCAPI_NULL if errors."/>
<kactus2:functionParameter kactus2:name="port_id" kactus2:type="mcapi_port_t" kactus2:transferType="any" kactus2:contentSource="port_id" kactus2:dependentParamIndex="-1" kactus2:description="The port id for the endpoint."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_get_endpoint_i" kactus2:description="Obtains the endpoint associated with the given tuple.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="node_id" kactus2:type="mcapi_node_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The node id of the node that owns the endpoint being obtained."/>
<kactus2:functionParameter kactus2:name="port_id" kactus2:type="mcapi_port_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The port id of the endpoint to obtain."/>
<kactus2:functionParameter kactus2:name="endpoint" kactus2:type="mcapi_endpoint_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The retrieved endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_get_endpoint" kactus2:description="Obtains the endpoint associated with the given tuple.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="node_id" kactus2:type="mcapi_node_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The node id of the node that owns the endpoint being obtained."/>
<kactus2:functionParameter kactus2:name="port_id" kactus2:type="mcapi_port_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The port id of the endpoint to obtain."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_delete_endpoint" kactus2:description="Deletes an endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The endpoint to delete."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_get_endpoint_attribute" kactus2:description="Retrieves endpoint attributes.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The endpoint whose attributes to retrieve."/>
<kactus2:functionParameter kactus2:name="attribute_num" kactus2:type="mcapi_uint_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The attribute number."/>
<kactus2:functionParameter kactus2:name="attribute" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The retrieved attribute value."/>
<kactus2:functionParameter kactus2:name="attribute_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The size of the retrieved attribute value."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_set_endpoint_attribute" kactus2:description="Sets endpoint attributes.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The endpoint whose attribute to set."/>
<kactus2:functionParameter kactus2:name="attribute_num" kactus2:type="mcapi_uint_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The attribute number."/>
<kactus2:functionParameter kactus2:name="attribute" kactus2:type="const void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The attribute value to set."/>
<kactus2:functionParameter kactus2:name="attribute_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The size of the attribute value."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_msg_send_i" kactus2:description="Sends a connectionless message from a send endpoint to a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The send endpoint (local)."/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="in" kactus2:contentSource="remote_endpoint_name" kactus2:dependentParamIndex="0" kactus2:description="The receive endpoint (remote)."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The data to send."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="priority" kactus2:type="mcapi_priority_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The message priority."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_msg_send" kactus2:description="Sends a connectionless message from a send endpoint to a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The send endpoint (local)."/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="in" kactus2:contentSource="remote_endpoint_name" kactus2:dependentParamIndex="0" kactus2:description="The receive endpoint (remote)."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The data to send."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="priority" kactus2:type="mcapi_priority_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The message priority."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_msg_recv_i" kactus2:description="Receives a connectionless message from a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="in" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The receive endpoint (local)."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer for incoming data."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Used to determined if the receive operation has completed."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_msg_recv" kactus2:description="Receives a connectionless message from a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="in" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The receive endpoint (local)."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer for incoming data."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="received_size" kactus2:type="size_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The actual size of the received message."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_msg_available" kactus2:description="Checks if messages are available on a receive endpoint.">
<kactus2:returnValue kactus2:type="mcapi_uint_t" kactus2:description="The number of messages available."/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="in" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The receive endpoint (local)."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_connect_pktchan_i" kactus2:description="Connects a pair of endpoints into a unidirectional FIFO channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The send endpoint."/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="remote_endpoint_name" kactus2:dependentParamIndex="1" kactus2:description="The receive endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_open_pktchan_recv_i" kactus2:description="Creates a typed, local representation of the channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_pktchan_recv_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The created receive handle."/>
<kactus2:functionParameter kactus2:name="recv_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="Name" kactus2:dependentParamIndex="0" kactus2:description="The corresponding receive endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_open_pktchan_send_i" kactus2:description="Opens the send end of a packet channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_pktchan_send_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="0" kactus2:description="The corresponding send endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_send_i" kactus2:description="Sends a (connected) packet on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_pktchan_send_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer containing the data to send."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_send" kactus2:description="Sends a (connected) packet on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_pktchan_send_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer containing the data to send."/>
<kactus2:functionParameter kactus2:name="buffer_size" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer size in bytes."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_recv_i" kactus2:description="Receives a (connected) packet on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_pktchan_recv_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void**" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Address of the system-supplied buffer containing the incoming data."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_recv" kactus2:description="">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_pktchan_recv_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void**" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Address of the system-supplied buffer containing the incoming data."/>
<kactus2:functionParameter kactus2:name="received_size" kactus2:type="size_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The actual size of the received packet."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_available" kactus2:description="Checks if packets are available on a receive endpoint.">
<kactus2:returnValue kactus2:type="mcapi_uint_t" kactus2:description="The number of packets available."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_pktchan_recv_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_free" kactus2:description="Releases a packet buffer obtains from a mcapi_pktchan_recv() call.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="buffer" kactus2:type="void*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The buffer to free."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_recv_close_i" kactus2:description="Closes channel on a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_pktchan_recv_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_pktchan_send_close_i" kactus2:description="Closes channel on a send endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_pktchan_send_hndl_t*" kactus2:transferType="packet" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_connect_sclchan_i" kactus2:description="Connects a pair of scalar channel endpoints.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="-1" kactus2:description="The send endpoint."/>
<kactus2:functionParameter kactus2:name="receive_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="remote_endpoint_name" kactus2:dependentParamIndex="0" kactus2:description="The receive endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_open_sclchan_recv_i" kactus2:description="Creates a typed, local representation of a scalar channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The created receive handle."/>
<kactus2:functionParameter kactus2:name="recv_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="Name" kactus2:dependentParamIndex="0" kactus2:description="The corresponding receive endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_open_sclchan_send_i" kactus2:description="">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="message" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="send_endpoint" kactus2:type="mcapi_endpoint_t" kactus2:transferType="message" kactus2:comDirection="out" kactus2:contentSource="Name" kactus2:dependentParamIndex="0" kactus2:description="The corresponding send endpoint."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_send_uint64" kactus2:description="Sends a (connected) 64-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="dataword" kactus2:type="mcapi_uint64_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The scalar to send."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_send_uint32" kactus2:description="Sends a (connected) 32-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="dataword" kactus2:type="mcapi_uint32_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The scalar to send."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_send_uint16" kactus2:description="Sends a (connected) 16-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="dataword" kactus2:type="mcapi_uint16_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The scalar to send."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_send_uint8" kactus2:description="Sends a (connected) 8-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="dataword" kactus2:type="mcapi_uint8_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The scalar to send."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_recv_uint64" kactus2:description="Receives a (connected) 64-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="mcapi_uint64_t" kactus2:description="The received dataword."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_recv_uint32" kactus2:description="Receives a (connected) 32-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="mcapi_uint32_t" kactus2:description="The received dataword."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_recv_uint16" kactus2:description="Receives a (connected) 16-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="mcapi_uint16_t" kactus2:description="The received dataword."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_recv_uint8" kactus2:description="Receives a (connected) 8-bit scalar on a channel.">
<kactus2:returnValue kactus2:type="mcapi_uint8_t" kactus2:description="The received dataword."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_available" kactus2:description="Checks if scalars are available on a receive endpoint.">
<kactus2:returnValue kactus2:type="mcapi_uint_t" kactus2:description="The number of scalars available."/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_recv_close_i" kactus2:description="Closes a channel on a receive endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="recv_handle" kactus2:type="mcapi_sclchan_recv_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="in" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The receive handle."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_sclchan_send_close_i" kactus2:description="Closes a channel on a send endpoint.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="send_handle" kactus2:type="mcapi_sclchan_send_hndl_t*" kactus2:transferType="scalar" kactus2:comDirection="out" kactus2:contentSource="handle_name" kactus2:dependentParamIndex="-1" kactus2:description="The send handle."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status for asynchronous operation."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_test" kactus2:description="Tests if a non-blocking operation has completed.">
<kactus2:returnValue kactus2:type="mcapi_boolean_t" kactus2:description="MCAPI_TRUE on success. MCAPI_FALSE if errors or not complete."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status."/>
<kactus2:functionParameter kactus2:name="size" kactus2:type="size_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The number of bytes sent/received."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_wait" kactus2:description="Waits for a non-blocking operation to complete.">
<kactus2:returnValue kactus2:type="mcapi_boolean_t" kactus2:description="MCAPI_TRUE on success. MCAPI_FALSE if errors."/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status."/>
<kactus2:functionParameter kactus2:name="size" kactus2:type="size_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The number of bytes sent/received."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
<kactus2:functionParameter kactus2:name="timeout" kactus2:type="mcapi_timeout_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The delay for timeout."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_wait_any" kactus2:description="Waits for any non-blocking operation in a list to complete.">
<kactus2:returnValue kactus2:type="mcapi_int_t" kactus2:description="The index into the request array of the mcapi_request_t identifier that has completed or has been canceled. On error, MCAPI_NULL is returned."/>
<kactus2:functionParameter kactus2:name="number" kactus2:type="size_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The number of requests in the array."/>
<kactus2:functionParameter kactus2:name="requests" kactus2:type="mcapi_request_t**" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The requests array."/>
<kactus2:functionParameter kactus2:name="size" kactus2:type="size_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The number of bytes sent/received."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
<kactus2:functionParameter kactus2:name="timeout" kactus2:type="mcapi_timeout_t" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="The delay for timeout."/>
</kactus2:function>
<kactus2:function kactus2:name="mcapi_cancel" kactus2:description="Cancels an outstanding non-blocking operation.">
<kactus2:returnValue kactus2:type="void" kactus2:description=""/>
<kactus2:functionParameter kactus2:name="request" kactus2:type="mcapi_request_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to request status."/>
<kactus2:functionParameter kactus2:name="mcapi_status" kactus2:type="mcapi_status_t*" kactus2:transferType="" kactus2:contentSource="" kactus2:dependentParamIndex="-1" kactus2:description="Pointer to status variable for checking against errors."/>
</kactus2:function>
</kactus2:functions>
</kactus2:apiDefinition>