libtrigger.h File Reference

Contains C versions of the trigger functions for the Open Agent Architecture. More...

Go to the source code of this file.

Defines
#define	EXTERN   extern
Functions
EXTERN int	oaa_CheckTriggers (char *type, ICLTerm *condition_var, char *op)
	Given a trigger type, a mask and an Op (e.g.
EXTERN int	oaa_AddTrigger (char *type, ICLTerm *condition, ICLTerm *action, ICLTerm *initial_params, ICLTerm **out_params)
	Adds a trigger according to parameters.
EXTERN int	oaa_RemoveTrigger (char *type, ICLTerm *condition, ICLTerm *action, ICLTerm *initial_params, ICLTerm **out_params)
	Removes a trigger from a local or remote agent.
int	oaa_add_trigger_local (char *type, ICLTerm *condition, ICLTerm *action, ICLTerm *params)
int	oaa_remove_trigger_local (char *type, ICLTerm *condition, ICLTerm *action, ICLTerm *params)

---

Detailed Description

Contains C versions of the trigger functions for the Open Agent Architecture.

Definition in file libtrigger.h.

---

Define Documentation

#define EXTERN   extern

Definition at line 36 of file libtrigger.h.

---

Function Documentation

int oaa_add_trigger_local	(	char *	type,
		ICLTerm *	condition,
		ICLTerm *	action,
		ICLTerm *	params
	)

Definition at line 574 of file libtrigger.c.

EXTERN int oaa_AddTrigger	(	char *	type,
		ICLTerm *	condition,
		ICLTerm *	action,
		ICLTerm *	initial_params,
		ICLTerm **	out_params
	)

Adds a trigger according to parameters.

Type = comm, data, task, time

Condition= comm:event to match, data:data to match, task:solvable to call time:@

Action = Can be any of these:

• oaa_Solve(Goal, Params)
• oaa_Interpret(Goal, Params)
• Goal [passed to oaa_Interpret with default params]

Params =

• address(X): a list including 'self', 'parent', and/or the addresses of other client agents. Default: see below.
• test(T): additional tests before trigger will fire [@needs work?]
• on(OP) : operation check: on(add), on(remove), on(receive), etc.
• recurrence(R): when, whenever, or integer (# of times to execute)
• reply({true,none}): When a trigger is being added on a remote agent or agents, this tells whether reply message(s) are desired.
• block(Mode) : true: Block until the reply arrives. : false: Don't block. In this case, the reply events can be handled by the user's app_do_event callback Default: true. Note that reply(none) overrides block(true).
• get_address(X): Returns a list of addresses (ids) of agents that were sent the request.
• get_satisfiers(X): Returns a list of addresses (ids) of agents that successfully completed the request.

Default destination for triggers:

• Data triggers: all agents with solvables matching the Condition field.
• All other types: the local agent

Definition at line 558 of file libtrigger.c.

EXTERN int oaa_CheckTriggers	(	char *	type,
		ICLTerm *	condition_var,
		char *	op
	)

Given a trigger type, a mask and an Op (e.g.

[send, receive], [add, remove], etc), see if any triggers fire.

Definition at line 99 of file libtrigger.c.

int oaa_remove_trigger_local	(	char *	type,
		ICLTerm *	condition,
		ICLTerm *	action,
		ICLTerm *	params
	)

Definition at line 598 of file libtrigger.c.

EXTERN int oaa_RemoveTrigger	(	char *	type,
		ICLTerm *	condition,
		ICLTerm *	action,
		ICLTerm *	initial_params,
		ICLTerm **	out_params
	)

Removes a trigger from a local or remote agent.

Definition at line 567 of file libtrigger.c.

---