exec_item.h File Reference

#include <cace/amm/lookup.h>
#include <cace/ari.h>
#include <m-atomic.h>
#include <semaphore.h>

Include dependency graph for exec_item.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	refda_exec_item_t
	Each item in an execution sequence, which corresponds to a dereferenced control. More...

Macros
#define	M_OPL_refda_exec_item_t()    (INIT(API_2(refda_exec_item_init)), CLEAR(API_2(refda_exec_item_deinit)), INIT_SET(0), SET(0))
	M*LIB OPLIST for refda_exec_item_t.

Typedefs
typedef struct refda_exec_seq_s	refda_exec_seq_t

Enumerations
enum	refda_exec_item_status_t { REFDA_EXEC_PENDING = 0 , REFDA_EXEC_RUNNING , REFDA_EXEC_WAITING , REFDA_EXEC_COMPLETE }
	Possible execution states for a single CTRL item refda_exec_item_t. More...

Functions
void	refda_exec_item_resume (refda_exec_item_t *obj)
void	refda_exec_item_init (refda_exec_item_t *obj)
	Interface for M*LIB use.
void	refda_exec_item_deinit (refda_exec_item_t *obj)
	Interface for M*LIB use.
int	refda_exec_item_finish_result (refda_exec_item_t *item)
	Check that the result of an exec item matches its needed type and mark the item as the finished state.

Macro Definition Documentation

M_OPL_refda_exec_item_t

#define M_OPL_refda_exec_item_t

(

)

(INIT(API_2(refda_exec_item_init)), CLEAR(API_2(refda_exec_item_deinit)), INIT_SET(0), SET(0))

M*LIB OPLIST for refda_exec_item_t.

Typedef Documentation

refda_exec_seq_t

typedef struct refda_exec_seq_s refda_exec_seq_t

Enumeration Type Documentation

refda_exec_item_status_t

enum refda_exec_item_status_t

Possible execution states for a single CTRL item refda_exec_item_t.

The final state of finished is when the item gets deleted.

Enumerator
REFDA_EXEC_PENDING	Indicator that this item is yet to be completed or paused.
REFDA_EXEC_RUNNING	Indicator that this item is running.
REFDA_EXEC_WAITING	Indicator that this item is waiting on an external event to complete.
REFDA_EXEC_COMPLETE	Indicator that this item completed execution but is not finished.

Function Documentation

refda_exec_item_deinit()

void refda_exec_item_deinit

(

refda_exec_item_t *

obj

)

Interface for M*LIB use.

References cace_amm_lookup_deinit(), cace_amm_user_data_deinit(), cace_ari_deinit(), CHKVOID, refda_exec_item_t::deref, refda_exec_item_t::ref, refda_exec_item_t::result, refda_exec_item_t::seq, and refda_exec_item_t::user_data.

refda_exec_item_finish_result()

int refda_exec_item_finish_result

(

refda_exec_item_t *

item

)

Check that the result of an exec item matches its needed type and mark the item as the finished state.

Precondition

The refda_exec_item_t::result member is set to the desired result.

Parameters

item	The item to check and update.

Postcondition

This will wake up the exec thread if the item was in the waiting state. Eventually refda_exec_ctrl_finish() will be called in the exec worker thread.

References refda_runctx_t::agent, cace_amm_obj_desc_t::app_data, cace_amm_type_is_valid(), cace_amm_type_match(), CACE_AMM_TYPE_MATCH_POSITIVE, cace_ari_deinit(), cace_ari_is_null(), cace_ari_is_undefined(), cace_ari_set_undefined(), CACE_ARI_TEXT_ENC_OPTS_DEFAULT, cace_ari_text_encode(), CACE_LOG_DEBUG, CACE_LOG_ERR, cace_log_is_enabled_for(), CHKERR1, refda_exec_item_t::deref, refda_agent_t::execs_sem, refda_exec_item_t::execution_stage, cace_amm_lookup_t::obj, cace_amm_user_data_t::ptr, REFDA_CTRL_EXEC_RESULT_TYPE_NOMATCH, REFDA_EXEC_COMPLETE, REFDA_EXEC_WAITING, refda_amm_ctrl_desc_t::res_type, refda_exec_item_t::result, refda_exec_seq_t::runctx, and refda_exec_item_t::seq.

Referenced by refda_ctrl_exec_ctx_set_result_copy(), refda_ctrl_exec_ctx_set_result_move(), and refda_ctrl_exec_ctx_set_result_null().

refda_exec_item_init()

void refda_exec_item_init

(

refda_exec_item_t *

obj

)

Interface for M*LIB use.

References cace_amm_lookup_init(), cace_amm_user_data_init(), cace_ari_init(), CHKVOID, refda_exec_item_t::deref, refda_exec_item_t::execution_stage, refda_exec_item_t::ref, REFDA_EXEC_PENDING, refda_exec_item_t::result, refda_exec_item_t::seq, and refda_exec_item_t::user_data.

refda_exec_item_resume()

void refda_exec_item_resume

(

refda_exec_item_t *

obj

)

Deprecated:

Use refda_exec_item_finish_result() instead. Wake up a "waiting" exec item. This can be called externally in the use case where there is an exec item that has been paused and deferred without blocking or using the timeline. Once this function is called, refda_exec_ctrl_finish will be called in the exec worker.

References refda_exec_item_t::execution_stage, REFDA_EXEC_COMPLETE, refda_exec_seq_t::runctx, and refda_exec_item_t::seq.