MobileC api header file. More...
#include <embedch.h>Go to the source code of this file.
Data Structures | |
| struct | agency_s |
| The agency handle. More... | |
| struct | MCAgencyOptions_s |
| User modifiable agency options. More... | |
| struct | stationary_agent_info_s |
Defines | |
| #define | EXPORTMC |
| #define | MC_Wait(arg1) MC_MainLoop(arg1) |
| #define | _ERROR_CODE_E_ |
| #define | MC_INITIALIZED_CODE 63280583 |
| #define | AGENT_T |
| #define | _FIPA_PERFORMATIVE_E_ |
Typedefs | |
| typedef int(* | MC_AgentInitCallbackFunc_t )(ChInterp_t interp, struct agent_s *agent, void *user_data) |
| typedef enum error_code_e | error_code_t |
| typedef enum MC_SteerCommand_e | MC_SteerCommand_t |
| Available commands for MC_Steer. | |
| typedef struct agency_s | agency_t |
| The agency handle. | |
| typedef agency_t * | agency_p |
| typedef agency_p | MCAgency_t |
| typedef struct MCAgencyOptions_s | MCAgencyOptions_t |
| User modifiable agency options. | |
| typedef struct stationary_agent_info_s | stationary_agent_info_t |
| typedef struct agent_s | agent_t |
| typedef agent_t * | MCAgent_t |
| typedef agent_t * | agent_p |
Enumerations | |
| enum | error_code_e { MC_SUCCESS = 0, MC_ERR, MC_ERR_CONNECT, MC_ERR_PARSE, MC_ERR_EMPTY, MC_ERR_INVALID, MC_ERR_INVALID_ARGS, MC_ERR_NOT_FOUND, MC_ERR_MEMORY, MC_ERR_SEND, MC_WARN_DUPLICATE, MC_SUCCESS = 0, ERR, MC_ERR_CONNECT, MC_ERR_PARSE, MC_ERR_EMPTY, MC_ERR_INVALID, MC_ERR_INVALID_ARGS, MC_ERR_NOT_FOUND, MC_ERR_MEMORY, MC_ERR_SEND, MC_ERR_OPTIONS_UNINITIALIZED, MC_WARN_DUPLICATE } |
| enum | MC_ThreadIndex_e { MC_THREAD_DF = 0, MC_THREAD_AMS, MC_THREAD_ACC, MC_THREAD_CP, MC_THREAD_AGENT, MC_THREAD_ALL } |
MobileC Module indices. More... | |
| enum | MC_QueueIndex_e { MC_QUEUE_MESSAGE, MC_QUEUE_AGENT, MC_QUEUE_CONNECTION, MC_QUEUE_SYNC, MC_QUEUE_BARRIER, MC_QUEUE_NUM } |
MobileC data queue indices. More... | |
| enum | MC_SteerCommand_e { MC_RUN = 0, MC_SUSPEND, MC_RESTART, MC_STOP } |
Available commands for MC_Steer. More... | |
| enum | MC_Signal_e { MC_NO_SIGNAL = 0x00, MC_RECV_CONNECTION = 0x01, MC_RECV_MESSAGE = 0x02, MC_RECV_AGENT = 0x04, MC_RECV_RETURN = 0x08, MC_EXEC_AGENT = 0x10, MC_ALL_SIGNALS = 0x20 } |
MobileC system signals. More... | |
| enum | MC_AgentType_e { MC_NONE = -1, MC_REMOTE_AGENT = 0, MC_LOCAL_AGENT, MC_RETURN_AGENT } |
| enum | MC_AgentStatus_e { MC_NO_STATUS = -1, MC_WAIT_CH = 0, MC_WAIT_MESSGSEND, MC_AGENT_ACTIVE, MC_AGENT_NEUTRAL, MC_AGENT_SUSPENDED, MC_WAIT_FINISHED } |
An agent's current execution state. More... | |
| enum | fipa_performative_e { FIPA_ERROR = -1, FIPA_ZERO, FIPA_ACCEPT_PROPOSAL, FIPA_AGREE, FIPA_CANCEL, FIPA_CALL_FOR_PROPOSAL, FIPA_CONFIRM, FIPA_DISCONFIRM, FIPA_FAILURE, FIPA_INFORM, FIPA_INFORM_IF, FIPA_INFORM_REF, FIPA_NOT_UNDERSTOOD, FIPA_PROPOGATE, FIPA_PROPOSE, FIPA_PROXY, FIPA_QUERY_IF, FIPA_QUERY_REF, FIPA_REFUSE, FIPA_REJECT_PROPOSAL, FIPA_REQUEST, FIPA_REQUEST_WHEN, FIPA_REQUEST_WHENEVER, FIPA_SUBSCRIBE, FIPA_ERROR = -1, FIPA_ZERO, FIPA_ACCEPT_PROPOSAL, FIPA_AGREE, FIPA_CANCEL, FIPA_CALL_FOR_PROPOSAL, FIPA_CONFIRM, FIPA_DISCONFIRM, FIPA_FAILURE, FIPA_INFORM, FIPA_INFORM_IF, FIPA_INFORM_REF, FIPA_NOT_UNDERSTOOD, FIPA_PROPOGATE, FIPA_PROPOSE, FIPA_PROXY, FIPA_QUERY_IF, FIPA_QUERY_REF, FIPA_REFUSE, FIPA_REJECT_PROPOSAL, FIPA_REQUEST, FIPA_REQUEST_WHEN, FIPA_REQUEST_WHENEVER, FIPA_SUBSCRIBE } |
Functions | |
| EXPORTMC int | MC_AclDestroy (struct fipa_acl_message_s *message) |
| Destroy a FIPA ACL message. | |
| EXPORTMC struct fipa_acl_message_s * | MC_AclNew (void) |
| Allocate a new ACL Message. | |
| EXPORTMC int | MC_AclPost (MCAgent_t agent, struct fipa_acl_message_s *message) |
| Post ACL message to agent. | |
| EXPORTMC struct fipa_acl_message_s * | MC_AclReply (struct fipa_acl_message_s *acl_message) |
| Reply to an ACL message. | |
| EXPORTMC struct fipa_acl_message_s * | MC_AclRetrieve (MCAgent_t agent) |
| Retrieve an ACL message. | |
| EXPORTMC int | MC_AclSend (MCAgency_t attr, struct fipa_acl_message_s *acl) |
| Send a composed ACL Message. | |
| EXPORTMC struct fipa_acl_message_s * | MC_AclWaitRetrieve (MCAgent_t agent) |
| Wait for and retrieve an ACL message. | |
| EXPORTMC enum fipa_protocol_e | MC_AclGetProtocol (struct fipa_acl_message_s *acl) |
| EXPORTMC char * | MC_AclGetConversationID (struct fipa_acl_message_s *acl) |
| EXPORTMC enum fipa_performative_e | MC_AclGetPerformative (struct fipa_acl_message_s *acl) |
| EXPORTMC int | MC_AclGetSender (struct fipa_acl_message_s *acl, char **name, char **address) |
| EXPORTMC const char * | MC_AclGetContent (struct fipa_acl_message_s *acl) |
| EXPORTMC int | MC_AclSetProtocol (struct fipa_acl_message_s *acl, enum fipa_protocol_e performative) |
| EXPORTMC int | MC_AclSetConversationID (struct fipa_acl_message_s *acl, const char *id) |
| EXPORTMC int | MC_AclSetPerformative (struct fipa_acl_message_s *acl, enum fipa_performative_e performative) |
| EXPORTMC int | MC_AclSetSender (struct fipa_acl_message_s *acl, const char *name, const char *address) |
| EXPORTMC int | MC_AclAddReceiver (struct fipa_acl_message_s *acl, const char *name, const char *address) |
| EXPORTMC int | MC_AclAddReplyTo (struct fipa_acl_message_s *acl, const char *name, const char *address) |
| EXPORTMC int | MC_AclSetContent (struct fipa_acl_message_s *acl, const char *content) |
| EXPORTMC int | MC_AddAgent (MCAgency_t attr, MCAgent_t agent) |
| Add an agent to the agency 'attr'. | |
| int | MC_AddStationaryAgent (MCAgency_t agency, void *(*agent_thread)(stationary_agent_info_t *), const char *name, void *agent_args) |
| Add a stationary agent to the agency. | |
| int | MC_AddAgentInitCallback (MCAgency_t agency, MC_AgentInitCallbackFunc_t function, void *user_data) |
| Add an agenct initialization callback function. | |
| int | MC_AgentAddTask (MCAgent_t agent, const char *code, const char *return_var_name, const char *server, int persistent) |
| Add a new task to an already existing agent. | |
| EXPORTMC int | MC_AgentAttachFile (MCAgent_t agent, const char *name, const char *filepath) |
| Attach a file to the agent's current task. | |
| EXPORTMC int | MC_AgentListFiles (MCAgent_t agent, int task_num, char ***names, int *num_files) |
| Get a list of an agent's attached files. | |
| EXPORTMC int | MC_AgentProcessingBegin (MCAgency_t attr) |
| Begin a series of agent functions. | |
| EXPORTMC int | MC_AgentProcessingEnd (MCAgency_t attr) |
| EXPORTMC int | MC_AgentRetrieveFile (MCAgent_t agent, int task_num, const char *name, const char *save_path) |
| Saves an agent's attached file to the filesystem. | |
| int | MC_AgentAddTaskFromFile (MCAgent_t agent, const char *filename, const char *return_var_name, const char *server, int persistent) |
| Add a new task to an already existing agent. | |
| MCAgency_t | MC_AgentInfo_GetAgency (stationary_agent_info_t *stationary_agent_info) |
| Get the host Mobile-C agency handle from a "stationary_agent_info_t" data structure. | |
| MCAgent_t | MC_AgentInfo_GetAgent (stationary_agent_info_t *stationary_agent_info) |
| Retrieve an agent handle from the stationary agent info from within a stationary agent. | |
| void * | MC_AgentInfo_GetAgentArgs (stationary_agent_info_t *stationary_agent_info) |
| Retrieve the agent argument supplied as the "agent_args" parameter in the MC_AddStationaryAgent() function. | |
| int | MC_AgentReturnArrayDim (MCAgent_t agent, int task_num) |
| Get the dimension of an agent's return data, if it is an array. | |
| int | MC_AgentReturnArrayExtent (MCAgent_t agent, int task_num, int index) |
| Get the extent of a dimension of an agent's return data, if it is an array. | |
| int | MC_AgentReturnArrayNum (MCAgent_t agent, int task_num) |
| Get the total number of elements of the agent return data. | |
| const void * | MC_AgentReturnDataGetSymbolAddr (MCAgent_t agent, int task_num) |
| Get a pointer to the agent's return data. | |
| size_t | MC_AgentReturnDataSize (MCAgent_t agent, int task_num) |
| Get the size of an agent's return data type. | |
| int | MC_AgentReturnDataType (MCAgent_t agent, int task_num) |
| Get the type of an agent's return data. | |
| int | MC_AgentReturnIsArray (MCAgent_t agent, int task_num) |
| Check to see whether or not an agent's return data is an array. | |
| const void * | MC_AgentVariableRetrieve (MCAgent_t agent, const char *var_name, int task_num) |
| Retrieve a pointer to a previously saved variable. | |
| int | MC_AgentVariableRetrieveInfo (MCAgent_t agent, const char *var_name, int task_num, const void **data, int *dim, const int **extent) |
| Retrieve a info about a previously saved variable. | |
| int | MC_AgentVariableSave (MCAgent_t agent, const char *var_name) |
| Mark an agent variable for saving. | |
| EXPORTMC int | MC_Barrier (MCAgency_t attr, int id) |
| EXPORTMC int | MC_BarrierDelete (MCAgency_t attr, int id) |
| Find and delete an initialized MobileC Barrier. | |
| EXPORTMC int | MC_BarrierInit (MCAgency_t attr, int id, int num_procs) |
| Initialize a MobileC Barrier. | |
| EXPORTMC int | MC_CallAgentFunc (MCAgent_t agent, const char *funcName, void *returnVal, int numArgs,...) |
| Use custom ChOptions_t type for internal Ch interpretor. | |
| EXPORTMC int | MC_CallAgentFuncArg (MCAgent_t agent, const char *funcName, void *returnVal, void *arg) |
| Calls a function defined in an agent. | |
| EXPORTMC int | MC_CallAgentFuncV (MCAgent_t agent, const char *funcName, void *returnVal, va_list ap) |
| Calls a function defined in an agent. | |
| EXPORTMC int | MC_CallAgentFuncVar (MCAgent_t agent, const char *funcName, void *returnVal, ChVaList_t arglist) |
| EXPORTMC MCAgent_t | MC_ComposeAgent (const char *name, const char *home, const char *owner, const char *code, const char *return_var_name, const char *server, int persistent) |
| Compose a new agent dynamically without using a prewritten XML file. | |
| EXPORTMC MCAgent_t | MC_ComposeAgentS (const char *name, const char *home, const char *owner, const char *code, const char *return_var_name, const char *server, int persistent, const char *workgroup_code) |
| Compose a new agent dynamically without using a prewritten XML file. | |
| EXPORTMC MCAgent_t | MC_ComposeAgentWithWorkgroup (const char *name, const char *home, const char *owner, const char *code, const char *return_var_name, const char *server, int persistent, const char *workgroup_code) |
| Compose a new agent dynamically without using a prewritten XML file. | |
| EXPORTMC MCAgent_t | MC_ComposeAgentFromFile (const char *name, const char *home, const char *owner, const char *filename, const char *return_var_name, const char *server, int persistent) |
| Compose a new agent dynamically from a source code file. | |
| EXPORTMC MCAgent_t | MC_ComposeAgentFromFileS (const char *name, const char *home, const char *owner, const char *filename, const char *return_var_name, const char *server, int persistent, const char *workgroup_code) |
| Compose a new agent dynamically from a source code file. | |
| EXPORTMC MCAgent_t | MC_ComposeAgentFromFileWithWorkgroup (const char *name, const char *home, const char *owner, const char *filename, const char *return_var_name, const char *server, int persistent, const char *workgroup_code) |
| Compose a new agent dynamically from a source code file. | |
| EXPORTMC int | MC_CondBroadcast (MCAgency_t attr, int id) |
| Wakes up all agents/threads waiting on a condition variable. | |
| EXPORTMC int | MC_CondSignal (MCAgency_t attr, int id) |
| Wakes up at least one thread waiting on a condition variable. | |
| EXPORTMC int | MC_CondReset (MCAgency_t attr, int id) |
| Reset a previously signalled MobileC condition variable. | |
| EXPORTMC int | MC_CondWait (MCAgency_t attr, int id) |
| Wait on a MobileC synchronization variable. | |
| int | MC_CopyAgent (MCAgent_t *agent_out, const MCAgent_t agent_in) |
| Performs a deep-copy of an agent structure. | |
| EXPORTMC int | MC_DeleteAgent (MCAgent_t agent) |
| Stop and remove an agent. | |
| EXPORTMC int | MC_DeleteAgentWG (MCAgent_t calling_agent, MCAgent_t agent) |
| Stop and remove an agent in the same workgroup. | |
| EXPORTMC int | MC_End (MCAgency_t attr) |
| End an agency. | |
| int | MC_DestroyServiceSearchResult (char **agentName, char **serviceName, int *agentID, int numResult) |
| Free memory allocated by a Service Search operation. | |
| EXPORTMC MCAgent_t | MC_FindAgentByName (MCAgency_t attr, const char *name) |
| Find an agent by its name. | |
| EXPORTMC MCAgent_t | MC_FindAgentByID (MCAgency_t attr, int ID) |
| Find an agent by its id. | |
| EXPORTMC void * | MC_GetAgentExecEngine (MCAgent_t agent) |
| Retrieve an agent's Ch interpreter. | |
| EXPORTMC int | MC_GetAgentID (MCAgent_t agent) |
| Retrieve an agent's id. | |
| EXPORTMC char * | MC_GetAgentName (MCAgent_t agent) |
| EXPORTMC int | MC_GetAgentNumTasks (MCAgent_t agent) |
| Retrive the number of tasks an agent has. | |
| EXPORTMC int | MC_GetAgentReturnData (MCAgent_t agent, int task_num, void **data, int *dim, int **extent) |
| Get an agent's return data. | |
| EXPORTMC int | MC_GetAgentStatus (MCAgent_t agent) |
| Get an agent's current status. | |
| EXPORTMC enum MC_AgentType_e | MC_GetAgentType (MCAgent_t agent) |
| Get an agent's type. | |
| EXPORTMC int | MC_GetAgents (MCAgency_t attr, MCAgent_t **agents, int *num_agents, unsigned int agent_status_flags) |
| Get a list of agents that match a certain agent status. | |
| EXPORTMC int | MC_GetAllAgents (MCAgency_t attr, MCAgent_t **agents, int *num_agents) |
| Get all of the agents on an agency. | |
| EXPORTMC int | MC_GetNumAgents (MCAgency_t attr, int *num_agents) |
| Get the number of agents residing on an agency. | |
| EXPORTMC char * | MC_GetAgentXMLString (MCAgent_t agent) |
| Get an agent's xml string. | |
| EXPORTMC int | MC_HaltAgency (MCAgency_t agency) |
| Halt an agency: Do not process new entries in queues. | |
| EXPORTMC MCAgency_t | MC_Initialize (int port, MCAgencyOptions_t *options) |
| Initialize and start a MobileC agency. | |
| EXPORTMC int | MC_InitializeAgencyOptions (struct MCAgencyOptions_s *options) |
| Initialize MobileC options. | |
| EXPORTMC int | MC_MainLoop (MCAgency_t attr) |
| Wait indefinitely. | |
| EXPORTMC int | MC_LoadAgentFromFile (MCAgency_t attr, const char *filename) |
| Load an agent from a file into an agency. | |
| EXPORTMC int | MC_MigrateAgent (MCAgent_t agent, const char *hostname, int port) |
| Migrates a running agent to another host. | |
| EXPORTMC int | MC_MutexLock (MCAgency_t attr, int id) |
| Locks a MobileC synchronization variable as a mutex. | |
| EXPORTMC int | MC_MutexUnlock (MCAgency_t attr, int id) |
| EXPORTMC int | MC_RegisterService (MCAgency_t agency, MCAgent_t agent, int agentID, const char *agentName, char **serviceNames, int numServices) |
| Register a new service with the Directory Facilitator. | |
| EXPORTMC int | MC_ResumeAgency (MCAgency_t agency) |
| Resumes a halted agency. | |
| EXPORTMC MCAgent_t | MC_RetrieveAgent (MCAgency_t attr) |
| Retrieves the oldest agent from an agency. | |
| EXPORTMC int | MC_SemaphorePost (MCAgency_t attr, int id) |
| Post to a MobileC synchronization variable semaphore. | |
| EXPORTMC int | MC_SemaphoreWait (MCAgency_t attr, int id) |
| Decreases a MobileC synchronization variable semaphore count by one. | |
| EXPORTMC int | MC_SetDefaultAgentStatus (MCAgency_t agency, enum MC_AgentStatus_e status) |
| Sets default incoming agent status. | |
| EXPORTMC int | MC_SetThreadOn (MCAgencyOptions_t *options, enum MC_ThreadIndex_e index) |
| Sets a MobileC thread to "on" status. | |
| EXPORTMC int | MC_SetThreadsAllOn (MCAgencyOptions_t *options) |
| Set all Mobile-C threads on. | |
| EXPORTMC int | MC_SetThreadOff (MCAgencyOptions_t *options, enum MC_ThreadIndex_e index) |
| Sets a MobileC thread to "off" status. | |
| EXPORTMC int | MC_SetThreadsAllOff (MCAgencyOptions_t *options) |
| Set all MobileC threads to 'off' status. | |
| EXPORTMC int | MC_PrintAgentCode (MCAgent_t agent) |
| Prints an agents code to stdout. | |
| EXPORTMC int | MC_QueueRDLock (MCAgency_t agency, enum MC_QueueIndex_e queue) |
| Lock an agency queue for reading. Prevents other threads from writing. | |
| EXPORTMC int | MC_QueueRDUnlock (MCAgency_t agency, enum MC_QueueIndex_e queue) |
| Unlock an agency queue that was previously locked for reading. | |
| EXPORTMC int | MC_QueueWRLock (MCAgency_t agency, enum MC_QueueIndex_e queue) |
| Lock an agency queue for writing. Prevents other threads from reading and writing. | |
| EXPORTMC int | MC_QueueWRUnlock (MCAgency_t agency, enum MC_QueueIndex_e queue) |
| Unlock an agency queue that was previously locked for writing. | |
| EXPORTMC char * | MC_RetrieveAgentCode (MCAgent_t agent) |
| Retrieves an agent's Ch code. | |
| EXPORTMC int | MC_ResetSignal (MCAgency_t attr) |
| Reset a MobileC signal. | |
| EXPORTMC int | MC_SearchForService (MCAgency_t attr, const char *searchString, char ***agentNames, char ***serviceNames, int **agentIDs, int *numResults) |
| Search the directory facilitator for a service. | |
| EXPORTMC int | MC_SendAgent (MCAgency_t attr, const char *message) |
| Sends an agent migration message. | |
| EXPORTMC int | MC_SendAgentFile (MCAgency_t attr, const char *filename) |
| Sends an agent migration message. | |
| EXPORTMC int | MC_SendAgentMigrationMessage (MCAgency_t attr, const char *message, const char *hostname, int port) |
| Sends an agent migration message. | |
| EXPORTMC int | MC_SendAgentMigrationMessageFile (MCAgency_t attr, const char *filename, const char *hostname, int port) |
| Sends an agent migration message. | |
| EXPORTMC int | MC_SetAgentStatus (MCAgent_t agent, enum MC_AgentStatus_e status) |
| Set an agent's status. | |
| EXPORTMC int | MC_Steer (MCAgency_t attr, int(*funcptr)(void *data), void *arg) |
| Set up a steerable algorithm. | |
| EXPORTMC enum MC_SteerCommand_e | MC_SteerControl (void) |
| The MobileC user-algorithm steering function. | |
| EXPORTMC int | MC_SyncDelete (MCAgency_t attr, int id) |
| Deletes a previously initialized synchronization variable. | |
| EXPORTMC int | MC_SyncInit (MCAgency_t attr, int id) |
| Initializes a new MobileC synchronization variable. | |
| EXPORTMC int | MC_TerminateAgent (MCAgent_t agent) |
| Halt a running agent. | |
| EXPORTMC int | MC_TerminateAgentWG (MCAgent_t calling_agent, MCAgent_t agent) |
| EXPORTMC int | MC_WaitAgent (MCAgency_t attr) |
| Wait indefinitely. | |
| EXPORTMC MCAgent_t | MC_WaitRetrieveAgent (MCAgency_t attr) |
| Wait and retrieve an agent. | |
| EXPORTMC int | MC_WaitSignal (MCAgency_t attr, int signals) |
| Wait for a MobileC signal. | |
MobileC api header file.
Definition in file libmc.h.
| #define MC_INITIALIZED_CODE 63280583 |
Definition at line 284 of file libmc.h.
Referenced by MC_Initialize(), and MC_InitializeAgencyOptions().
| typedef enum error_code_e error_code_t |
| typedef int(* MC_AgentInitCallbackFunc_t)(ChInterp_t interp, struct agent_s *agent, void *user_data) |
| typedef enum MC_SteerCommand_e MC_SteerCommand_t |
Available commands for MC_Steer.
| typedef agency_p MCAgency_t |
| typedef struct MCAgencyOptions_s MCAgencyOptions_t |
User modifiable agency options.
| typedef struct stationary_agent_info_s stationary_agent_info_t |
| enum error_code_e |
| enum fipa_performative_e |
| enum MC_AgentStatus_e |
| enum MC_AgentType_e |
| enum MC_QueueIndex_e |
| enum MC_Signal_e |
MobileC system signals.
| enum MC_SteerCommand_e |
| enum MC_ThreadIndex_e |
| EXPORTMC int MC_AclAddReceiver | ( | struct fipa_acl_message_s * | acl, | |
| const char * | name, | |||
| const char * | address | |||
| ) |
Definition at line 337 of file libmc.c.
References fipa_agent_identifier_s::addresses, fipa_agent_identifier_New(), fipa_agent_identifier_set_New(), fipa_agent_identifier_set_s::fipa_agent_identifiers, fipa_url_New(), fipa_url_sequence_New(), fipa_agent_identifier_s::name, fipa_url_sequence_s::num, fipa_agent_identifier_set_s::num, fipa_acl_message_s::receiver, fipa_acl_message_s::receiver_num, fipa_url_s::str, strdup, and fipa_url_sequence_s::urls.
Referenced by MC_AclAddReceiver_chdl().
| EXPORTMC int MC_AclAddReplyTo | ( | struct fipa_acl_message_s * | acl, | |
| const char * | name, | |||
| const char * | address | |||
| ) |
Definition at line 373 of file libmc.c.
References fipa_agent_identifier_s::addresses, fipa_agent_identifier_New(), fipa_agent_identifier_set_New(), fipa_agent_identifier_set_s::fipa_agent_identifiers, fipa_url_New(), fipa_url_sequence_New(), fipa_agent_identifier_s::name, fipa_url_sequence_s::num, fipa_agent_identifier_set_s::num, fipa_acl_message_s::reply_to, fipa_url_s::str, strdup, and fipa_url_sequence_s::urls.
Referenced by MC_AclAddReplyTo_chdl().
| EXPORTMC int MC_AclDestroy | ( | struct fipa_acl_message_s * | message | ) |
Destroy a FIPA ACL message.
| message | The ACL message to destroy |
Definition at line 84 of file libmc.c.
References fipa_acl_message_Destroy().
Referenced by MC_AclDestroy_chdl().
| EXPORTMC const char* MC_AclGetContent | ( | struct fipa_acl_message_s * | acl | ) |
Definition at line 265 of file libmc.c.
References fipa_string_s::content, and fipa_acl_message_s::content.
Referenced by MC_AclGetContent_chdl().
| EXPORTMC char* MC_AclGetConversationID | ( | struct fipa_acl_message_s * | acl | ) |
Definition at line 240 of file libmc.c.
References fipa_string_s::content, fipa_expression_s::content, fipa_acl_message_s::conversation_id, and fipa_expression_s::content_u::string.
Referenced by MC_AclGetConversationID_chdl().
| EXPORTMC enum fipa_performative_e MC_AclGetPerformative | ( | struct fipa_acl_message_s * | acl | ) |
Definition at line 246 of file libmc.c.
References fipa_acl_message_s::performative.
Referenced by MC_AclGetPerformative_chdl().
| EXPORTMC enum fipa_protocol_e MC_AclGetProtocol | ( | struct fipa_acl_message_s * | acl | ) |
Definition at line 234 of file libmc.c.
References fipa_acl_message_s::performative.
Referenced by MC_AclGetProtocol_chdl().
| EXPORTMC int MC_AclGetSender | ( | struct fipa_acl_message_s * | acl, | |
| char ** | name, | |||
| char ** | address | |||
| ) |
Definition at line 252 of file libmc.c.
References fipa_agent_identifier_s::addresses, fipa_agent_identifier_s::name, fipa_acl_message_s::sender, fipa_url_s::str, strdup, and fipa_url_sequence_s::urls.
Referenced by MC_AclGetSender_chdl().
| EXPORTMC struct fipa_acl_message_s* MC_AclNew | ( | void | ) | [read] |
Allocate a new ACL Message.
Definition at line 90 of file libmc.c.
References fipa_acl_message_New().
Referenced by MC_AclNew_chdl().
| EXPORTMC int MC_AclPost | ( | MCAgent_t | agent, | |
| struct fipa_acl_message_s * | message | |||
| ) |
Post ACL message to agent.
| agent | The agent to post the message to | |
| message | The message to post |
Definition at line 95 of file libmc.c.
References ListAdd(), ListWRLock(), ListWRUnlock(), and agent_s::mailbox.
Referenced by MC_AclPost_chdl(), and MC_AclSend().
| EXPORTMC struct fipa_acl_message_s* MC_AclReply | ( | struct fipa_acl_message_s * | acl_message | ) | [read] |
Reply to an ACL message.
| acl_message | The incoming acl message to reply to |
Definition at line 104 of file libmc.c.
References fipa_Reply().
Referenced by MC_AclReply_chdl().
| EXPORTMC struct fipa_acl_message_s* MC_AclRetrieve | ( | MCAgent_t | agent | ) | [read] |
Retrieve an ACL message.
| agent | Agent to retrieve message from. |
Definition at line 110 of file libmc.c.
References ListPop(), ListWRLock(), ListWRUnlock(), and agent_s::mailbox.
Referenced by MC_AclRetrieve_chdl().
| EXPORTMC int MC_AclSend | ( | MCAgency_t | attr, | |
| struct fipa_acl_message_s * | acl | |||
| ) |
Send a composed ACL Message.
| attr | An initialized and running MobileC agency | |
| acl | An allocated and fully composed ACL message. |
Definition at line 120 of file libmc.c.
References fipa_agent_identifier_s::addresses, mtp_http_s::content, mtp_http_content_s::content_type, mtp_http_content_s::data, dynstring_Destroy(), FIPA_ACL, fipa_acl_Compose(), fipa_acl_message_Copy(), fipa_agent_identifier_set_s::fipa_agent_identifiers, fipa_envelope_Compose(), mtp_http_s::host, http_to_hostport(), MC_AclPost(), MC_FindAgentByName(), agency_s::mc_platform, dynstring_s::message, mtp_http_s::message_parts, message_Send(), message_s::message_type, mtp_http_CreateMessage(), mtp_http_Destroy(), mtp_http_New(), fipa_agent_identifier_s::name, fipa_url_sequence_s::num, fipa_agent_identifier_set_s::num, port, mc_platform_s::private_key, fipa_acl_message_s::receiver, fipa_url_s::str, strdup, message_s::target, mtp_http_s::target, and fipa_url_sequence_s::urls.
Referenced by MC_AclSend_chdl().
| EXPORTMC int MC_AclSetContent | ( | struct fipa_acl_message_s * | acl, | |
| const char * | content | |||
| ) |
Definition at line 408 of file libmc.c.
References fipa_string_s::content, fipa_acl_message_s::content, fipa_string_Destroy(), fipa_string_New(), and strdup.
Referenced by MC_AclSetContent_chdl().
| EXPORTMC int MC_AclSetConversationID | ( | struct fipa_acl_message_s * | acl, | |
| const char * | id | |||
| ) |
Definition at line 287 of file libmc.c.
References fipa_string_s::content, fipa_expression_s::content, fipa_acl_message_s::conversation_id, FIPA_EXPR_STRING, fipa_expression_New(), fipa_string_New(), strdup, fipa_expression_s::content_u::string, and fipa_expression_s::type.
Referenced by MC_AclSetConversationID_chdl().
| EXPORTMC int MC_AclSetPerformative | ( | struct fipa_acl_message_s * | acl, | |
| enum fipa_performative_e | performative | |||
| ) |
Definition at line 306 of file libmc.c.
References fipa_acl_message_s::performative.
Referenced by MC_AclSetPerformative_chdl().
| EXPORTMC int MC_AclSetProtocol | ( | struct fipa_acl_message_s * | acl, | |
| enum fipa_protocol_e | performative | |||
| ) |
Definition at line 271 of file libmc.c.
References FIPA_PROTOCOL_END, FIPA_PROTOCOL_ERROR, and fipa_acl_message_s::protocol.
Referenced by MC_AclSetProtocol_chdl().
| EXPORTMC int MC_AclSetSender | ( | struct fipa_acl_message_s * | acl, | |
| const char * | name, | |||
| const char * | address | |||
| ) |
Definition at line 314 of file libmc.c.
References fipa_agent_identifier_s::addresses, fipa_agent_identifier_Destroy(), fipa_agent_identifier_New(), fipa_url_New(), fipa_url_sequence_New(), fipa_agent_identifier_s::name, fipa_url_sequence_s::num, fipa_acl_message_s::sender, fipa_url_s::str, strdup, and fipa_url_sequence_s::urls.
Referenced by MC_AclSetSender_chdl().
| EXPORTMC struct fipa_acl_message_s* MC_AclWaitRetrieve | ( | MCAgent_t | agent | ) | [read] |
Wait for and retrieve an ACL message.
| agent | Agent to retrieve message from. |
Definition at line 218 of file libmc.c.
References ListPop(), ListWRLock(), ListWRUnlock(), ListWRWait(), and agent_s::mailbox.
Referenced by MC_AclWaitRetrieve_chdl().
| EXPORTMC int MC_AddAgent | ( | MCAgency_t | attr, | |
| MCAgent_t | agent | |||
| ) |
Add an agent to the agency 'attr'.
| attr | a MobileC agency | |
| agent | An initialized MobileC agent |
Definition at line 425 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, mc_platform_s::ams, COND_SIGNAL, ListAdd(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, agent_s::mc_platform, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by handler_COMPOSE_SEND(), and MC_AddAgent_chdl().
| int MC_AddAgentInitCallback | ( | MCAgency_t | agency, | |
| MC_AgentInitCallbackFunc_t | function, | |||
| void * | user_data | |||
| ) |
Add an agenct initialization callback function.
| agency | a MobileC agency | |
| function | The callback function to add. This callback function will be called after an interpreter is initialized for an agent but before the agent is executed. | |
| user_data | A pointer to any user data that should be made available to the callback function |
Definition at line 474 of file libmc.c.
References agency_s::agentInitCallback, and agency_s::agentInitUserData.
| int MC_AddStationaryAgent | ( | MCAgency_t | agency, | |
| void *(*)(stationary_agent_info_t *) | agent_thread, | |||
| const char * | name, | |||
| void * | agent_args | |||
| ) |
Add a stationary agent to the agency.
| agency | a MobileC agency | |
| agent_thread | The binary-space agent function | |
| name | The new agent's name | |
| agent_args | user arguments to pass to the agent |
Definition at line 442 of file libmc.c.
References stationary_agent_info_s::agency, stationary_agent_info_s::agent, agent_NewBinary(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, stationary_agent_info_s::args, stationary_agent_info_s::attr, ListAdd(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, agent_s::name, strdup, stationary_agent_info_s::thread, and THREAD_CREATE.
| int MC_AgentAddTask | ( | MCAgent_t | agent, | |
| const char * | code, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent | |||
| ) |
Add a new task to an already existing agent.
| agent | An existing agent | |
| code | The C code to use in the new task | |
| return_var_name | The name of the the return variable, or NULL if there is no return variable. | |
| server | The server to perform the task on. | |
| persistent | Whether or not the task is persistent. '1' indicates persistent, and '0' indicates not-persistent (the default) |
Definition at line 499 of file libmc.c.
References agent_datastate_s::agent_code_ids, agent_datastate_s::agent_codes, agent_task_New(), agent_task_s::code_id, agent_s::datastate, agent_datastate_s::number_of_tasks, agent_task_s::persistent, agent_task_s::server_name, strdup, agent_datastate_s::tasks, and agent_task_s::var_name.
Referenced by MC_AgentAddTask_chdl(), and MC_AgentAddTaskFromFile().
| int MC_AgentAddTaskFromFile | ( | MCAgent_t | agent, | |
| const char * | filename, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent | |||
| ) |
Add a new task to an already existing agent.
| agent | An existing agent | |
| filename | The C code to use in the new task | |
| return_var_name | The name of the the return variable, or NULL if there is no return variable. | |
| server | The server to perform the task on. | |
| persistent | Whether or not the task is persistent. '1' indicates persistent, and '0' indicates not-persistent (the default) |
Definition at line 572 of file libmc.c.
References MC_AgentAddTask().
| EXPORTMC int MC_AgentAttachFile | ( | MCAgent_t | agent, | |
| const char * | name, | |||
| const char * | filepath | |||
| ) |
Attach a file to the agent's current task.
| agent | An existing agent | |
| name | The name to give the file | |
| filepath | The absolute path of the file |
Definition at line 608 of file libmc.c.
References agent_file_data_InitializeFromFilename(), agent_task_s::agent_file_list, agent_s::datastate, ListAdd(), ListWRLock(), ListWRUnlock(), agent_file_data_s::name, strdup, agent_datastate_s::task_progress, and agent_datastate_s::tasks.
Referenced by MC_AgentAttachFile_chdl().
| MCAgency_t MC_AgentInfo_GetAgency | ( | stationary_agent_info_t * | stationary_agent_info | ) |
Get the host Mobile-C agency handle from a "stationary_agent_info_t" data structure.
| stationary_agent_info | A stationary_agent_info_t type variable provided to a stationary agent function |
Definition at line 484 of file libmc.c.
References stationary_agent_info_s::agency.
| MCAgent_t MC_AgentInfo_GetAgent | ( | stationary_agent_info_t * | stationary_agent_info | ) |
Retrieve an agent handle from the stationary agent info from within a stationary agent.
| stationary_agent_info | A stationary_agent_info_t type variable provided to a stationary agent function |
The following example demonstrates usage of MC_AgentInfo_GetAgent()
Definition at line 489 of file libmc.c.
References stationary_agent_info_s::agent.
| void* MC_AgentInfo_GetAgentArgs | ( | stationary_agent_info_t * | stationary_agent_info | ) |
Retrieve the agent argument supplied as the "agent_args" parameter in the MC_AddStationaryAgent() function.
| stationary_agent_info | A stationary_agent_info_t type variable provided to a stationary agent function |
Definition at line 494 of file libmc.c.
References stationary_agent_info_s::args.
| EXPORTMC int MC_AgentListFiles | ( | MCAgent_t | agent, | |
| int | task_num, | |||
| char *** | names, | |||
| int * | num_files | |||
| ) |
Get a list of an agent's attached files.
| agent | An existing agent | |
| names | A pointer two an unallocated two dimentional character array. The function will allocated any necessary memory for storing the names. If names are allocated, the array must be freed by the user. | |
| num_files | A pointer to an integer which will be filled with the number of filenames |
Definition at line 630 of file libmc.c.
References agent_task_s::agent_file_list, agent_s::datastate, ListGetSize(), ListRDLock(), ListRDUnlock(), ListSearch(), agent_file_data_s::name, agent_datastate_s::number_of_tasks, strdup, and agent_datastate_s::tasks.
Referenced by MC_AgentListFiles_chdl().
| EXPORTMC int MC_AgentProcessingBegin | ( | MCAgency_t | attr | ) |
Begin a series of agent functions.
| agency | A handle to a running agency |
Definition at line 663 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListWRLock(), and agency_s::mc_platform.
| EXPORTMC int MC_AgentProcessingEnd | ( | MCAgency_t | attr | ) |
Definition at line 671 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListWRUnlock(), and agency_s::mc_platform.
| EXPORTMC int MC_AgentRetrieveFile | ( | MCAgent_t | agent, | |
| int | task_num, | |||
| const char * | name, | |||
| const char * | save_path | |||
| ) |
Saves an agent's attached file to the filesystem.
| name | The name of the agent's stored file | |
| save_path | The location to save the file (including the filename) |
Definition at line 678 of file libmc.c.
References agent_file_data_CmpName(), agent_task_s::agent_file_list, base64_decode_block(), base64_init_decodestate(), agent_file_data_s::data, agent_s::datastate, ListRDLock(), ListRDUnlock(), ListSearchCB(), agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
Referenced by MC_AgentRetrieveFile_chdl().
| int MC_AgentReturnArrayDim | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Get the dimension of an agent's return data, if it is an array.
| agent | A return agent | |
| task | task to retrieve the agent return data size from |
Definition at line 748 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::array_dim, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| int MC_AgentReturnArrayExtent | ( | MCAgent_t | agent, | |
| int | task_num, | |||
| int | index | |||
| ) |
Get the extent of a dimension of an agent's return data, if it is an array.
| agent | A return agent | |
| task | task to retrieve the agent return data size from | |
| index | The dimension index to get the extent |
Definition at line 724 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::array_dim, interpreter_variable_data_s::array_extent, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| int MC_AgentReturnArrayNum | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Get the total number of elements of the agent return data.
| agent | A return agent | |
| task | task to retrieve the agent return data size from | |
| index | The dimension index to get the extent |
Definition at line 766 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::array_dim, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| const void* MC_AgentReturnDataGetSymbolAddr | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Get a pointer to the agent's return data.
| agent | A return agent | |
| task | task to retrieve the agent return data from |
Definition at line 796 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::data, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| size_t MC_AgentReturnDataSize | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Get the size of an agent's return data type.
| agent | A return agent | |
| task | task to retrieve the agent return data type size from |
Definition at line 813 of file libmc.c.
References agent_task_s::agent_return_data, CH_DATATYPE_SIZE, interpreter_variable_data_s::data_type, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| int MC_AgentReturnDataType | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Get the type of an agent's return data.
| agent | A return agent | |
| task | task to retrieve the agent return data type from |
Definition at line 836 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::data_type, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| int MC_AgentReturnIsArray | ( | MCAgent_t | agent, | |
| int | task_num | |||
| ) |
Check to see whether or not an agent's return data is an array.
| agent | A return agent | |
| task | task to check to see if the return data is an array. |
Definition at line 846 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::array_dim, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| const void* MC_AgentVariableRetrieve | ( | MCAgent_t | agent, | |
| const char * | var_name, | |||
| int | task_num | |||
| ) |
Retrieve a pointer to a previously saved variable.
| agent | A MobileC agent. | |
| var_name | The name of the saved variable that has previously been saved. | |
| task_num | The previous completed task from which to retrieve the saved variable. |
The following example demonstrates usage of MC_AgentVariableRetrieve() from agent space.
Definition at line 867 of file libmc.c.
References agent_task_s::agent_variable_list, interpreter_variable_data_s::data, agent_s::datastate, interpreter_variable_data_CmpName(), ListRDLock(), ListRDUnlock(), ListSearchCB(), agent_datastate_s::task_progress, and agent_datastate_s::tasks.
Referenced by MC_AgentVariableRetrieve_chdl().
| int MC_AgentVariableRetrieveInfo | ( | MCAgent_t | agent, | |
| const char * | var_name, | |||
| int | task_num, | |||
| const void ** | data, | |||
| int * | dim, | |||
| const int ** | extent | |||
| ) |
Retrieve a info about a previously saved variable.
| agent | A MobileC agent. | |
| var_name | The name of the saved variable that has previously been saved. | |
| task_num | The previous completed task from which to retrieve the saved variable. | |
| data | (Output) The Variable Data | |
| dim | (Output) The dimension of the data array | |
| extent | (Output) The extents of the output array |
Definition at line 888 of file libmc.c.
References agent_task_s::agent_variable_list, interpreter_variable_data_s::array_dim, interpreter_variable_data_s::array_extent, interpreter_variable_data_s::data, agent_s::datastate, interpreter_variable_data_CmpName(), ListRDLock(), ListRDUnlock(), ListSearchCB(), MC_ERR_NOT_FOUND, MC_SUCCESS, agent_datastate_s::task_progress, and agent_datastate_s::tasks.
| int MC_AgentVariableSave | ( | MCAgent_t | agent, | |
| const char * | var_name | |||
| ) |
Mark an agent variable for saving.
| agent | A MobileC agent. | |
| var_name | The name of the variable to mark for saving. |
See agent_saved_variables_example/test1.xml for an example of usage of this api function.
The following example demonstrates usage of MC_AgentVariableSave() from agent space.
Definition at line 912 of file libmc.c.
References agent_s::datastate, MC_ERR_MEMORY, agent_task_s::num_saved_variables, agent_task_s::saved_variables, strdup, agent_datastate_s::task_progress, and agent_datastate_s::tasks.
Referenced by MC_AgentVariableSave_chdl().
| EXPORTMC int MC_Barrier | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Definition at line 933 of file libmc.c.
References barrier_node_CmpID(), mc_platform_s::barrier_queue, barrier_node_s::cond, COND_BROADCAST, COND_WAIT, ListRDLock(), ListRDUnlock(), ListSearchCB(), barrier_node_s::lock, MC_ERR_NOT_FOUND, agency_s::mc_platform, MC_SUCCESS, MUTEX_LOCK, MUTEX_UNLOCK, barrier_node_s::num_registered, and barrier_node_s::num_waiting.
Referenced by MC_Barrier_chdl().
| EXPORTMC int MC_BarrierDelete | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Find and delete an initialized MobileC Barrier.
| attr | A running MobileC agency | |
| id | The id of the barrier node to delete |
Definition at line 982 of file libmc.c.
References barrier_node_CmpID(), barrier_node_Destroy(), mc_platform_s::barrier_queue, ListDeleteCB(), ListWRLock(), ListWRUnlock(), and agency_s::mc_platform.
Referenced by MC_BarrierDelete_chdl().
| EXPORTMC int MC_BarrierInit | ( | MCAgency_t | attr, | |
| int | id, | |||
| int | num_procs | |||
| ) |
Initialize a MobileC Barrier.
| attr | A running MobileC agency | |
| id | The requested barrier id | |
| num_procs | The number of agents/threads/processes that will wait on the barrier |
The following example demonstrates an agent which sets up an MC_Barrier.
Definition at line 961 of file libmc.c.
References barrier_node_CmpID(), barrier_node_Initialize(), mc_platform_s::barrier_queue, ListAdd(), ListRDLock(), ListRDUnlock(), ListSearchCB(), ListWRLock(), ListWRUnlock(), MC_ERR, agency_s::mc_platform, and MC_SUCCESS.
Referenced by MC_BarrierInit_chdl().
| EXPORTMC int MC_CallAgentFunc | ( | MCAgent_t | agent, | |
| const char * | funcName, | |||
| void * | returnVal, | |||
| int | numArgs, | |||
| ... | ||||
| ) |
Use custom ChOptions_t type for internal Ch interpretor.
| attr | A running MobileC agency | |
| options | Initialized Ch options structure |
| agent | An initialized and executed MobileC agent | |
| funcName | The name of the function to call | |
| returnVal | The agent function's return value | |
| numArgs | The number of arguments supplied to the agent function | |
| ... | A variable argument list to be supplied to the agent function |
Definition at line 1000 of file libmc.c.
References agent_s::agent_interp, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::run_lock.
| EXPORTMC int MC_CallAgentFuncArg | ( | MCAgent_t | agent, | |
| const char * | funcName, | |||
| void * | returnVal, | |||
| void * | arg | |||
| ) |
Calls a function defined in an agent.
| agent | An initialized and executed MobileC agent | |
| funcName | The name of the function to call | |
| returnVal | The agent function's return value | |
| arg | The agent functions argument |
Definition at line 1021 of file libmc.c.
References agent_s::agent_interp, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::run_lock.
| EXPORTMC int MC_CallAgentFuncV | ( | MCAgent_t | agent, | |
| const char * | funcName, | |||
| void * | returnVal, | |||
| va_list | ap | |||
| ) |
Calls a function defined in an agent.
| agent | An initialized and executed MobileC agent | |
| funcName | The name of the function to call | |
| returnVal | The agent function's return value | |
| ap | A variable argument list |
Definition at line 1040 of file libmc.c.
References agent_s::agent_interp, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::run_lock.
| EXPORTMC int MC_CallAgentFuncVar | ( | MCAgent_t | agent, | |
| const char * | funcName, | |||
| void * | returnVal, | |||
| ChVaList_t | arglist | |||
| ) |
Definition at line 1060 of file libmc.c.
References agent_s::agent_interp, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::run_lock.
Referenced by MC_CallAgentFunc_chdl().
| EXPORTMC MCAgent_t MC_ComposeAgent | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | code, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent | |||
| ) |
Compose a new agent dynamically without using a prewritten XML file.
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1100 of file libmc.c.
References MC_ComposeAgentWithWorkgroup().
| EXPORTMC MCAgent_t MC_ComposeAgentFromFile | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | filename, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent | |||
| ) |
Compose a new agent dynamically from a source code file.
| filename | The filename of the source file | |
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1226 of file libmc.c.
References MC_ComposeAgentFromFileWithWorkgroup().
Referenced by handler_COMPOSE_SEND().
| EXPORTMC MCAgent_t MC_ComposeAgentFromFileS | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | filename, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent, | |||
| const char * | workgroup_code | |||
| ) |
Compose a new agent dynamically from a source code file.
| filename | The filename of the source file | |
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| workgroup_code | The secret workgroup code of the agent. Only agents with the same workgroup code may perform certain interactions. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1248 of file libmc.c.
References MC_ComposeAgentFromFileWithWorkgroup().
| EXPORTMC MCAgent_t MC_ComposeAgentFromFileWithWorkgroup | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | filename, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent, | |||
| const char * | workgroup_code | |||
| ) |
Compose a new agent dynamically from a source code file.
| filename | The filename of the source file | |
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| workgroup_code | The secret workgroup code of the agent. Only agents with the same workgroup code may perform certain interactions. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1273 of file libmc.c.
References MC_ComposeAgentWithWorkgroup().
Referenced by MC_ComposeAgentFromFile(), MC_ComposeAgentFromFile_chdl(), MC_ComposeAgentFromFileS(), and MC_ComposeAgentFromFileWithWorkgroup_chdl().
| EXPORTMC MCAgent_t MC_ComposeAgentS | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | code, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent, | |||
| const char * | workgroup_code | |||
| ) |
Compose a new agent dynamically without using a prewritten XML file.
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| workgroup_code | The secret workgroup code of the agent. Only agents with the same workgroup code may perform certain interactions. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1123 of file libmc.c.
References MC_ComposeAgentWithWorkgroup().
Referenced by MC_ComposeAgentWithWorkgroup_chdl().
| EXPORTMC MCAgent_t MC_ComposeAgentWithWorkgroup | ( | const char * | name, | |
| const char * | home, | |||
| const char * | owner, | |||
| const char * | code, | |||
| const char * | return_var_name, | |||
| const char * | server, | |||
| int | persistent, | |||
| const char * | workgroup_code | |||
| ) |
Compose a new agent dynamically without using a prewritten XML file.
| name | The desired name of the new agent. | |
| home | The home of the new agent. | |
| owner | The owner of the new agent. | |
| code | The agent code | |
| return_var_name | The name of the agent's return variable. Set to "no-return" if no return variable is desired. | |
| server | The target destination of the agent. | |
| workgroup_code | The secret workgroup code of the agent. Only agents with the same workgroup code may perform certain interactions. | |
| persitent | A flag indicating whether or not the agent should be persistent. A value of '1' indicates persistence, while a value of '0' indicates default non-persistent behaviour. |
Definition at line 1149 of file libmc.c.
References agent_datastate_s::agent_code, agent_datastate_s::agent_code_ids, agent_datastate_s::agent_codes, agent_datastate_New(), agent_New(), agent_s::agent_status, agent_task_New(), agent_s::agent_type, agent_s::datastate, agent_s::home, MC_LOCAL_AGENT, MC_WAIT_MESSGSEND, agent_s::name, agent_datastate_s::number_of_tasks, agent_s::orphan, agent_s::owner, agent_task_s::persistent, agent_task_s::server_name, strdup, agent_datastate_s::tasks, agent_task_s::var_name, and agent_s::wg_code.
Referenced by MC_ComposeAgent(), MC_ComposeAgent_chdl(), MC_ComposeAgentFromFileWithWorkgroup(), and MC_ComposeAgentS().
| EXPORTMC int MC_CondBroadcast | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Wakes up all agents/threads waiting on a condition variable.
| attr | A MobileC agency | |
| id | Synchronization variable id to broadcast to |
Definition at line 1319 of file libmc.c.
References syncListNode_s::cond, COND_BROADCAST, ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, MC_ERR_NOT_FOUND, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, syncListNode_s::signalled, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_CondBroadcast_chdl().
| EXPORTMC int MC_CondReset | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Reset a previously signalled MobileC condition variable.
| attr | A MobileC Agency | |
| id | The synchronization variable id to reset |
Definition at line 1386 of file libmc.c.
References ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, MC_ERR_NOT_FOUND, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, syncListNode_s::signalled, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_CondReset_chdl().
| EXPORTMC int MC_CondSignal | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Wakes up at least one thread waiting on a condition variable.
| attr | A MobileC agency | |
| id | synchronization variable id |
The following example demonstrates the agent-space version of the function, which is nearly identical to the binary space api function.
Definition at line 1339 of file libmc.c.
References syncListNode_s::cond, COND_SIGNAL, ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, MC_ERR_NOT_FOUND, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, syncListNode_s::signalled, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_CondSignal_chdl().
| EXPORTMC int MC_CondWait | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Wait on a MobileC synchronization variable.
| attr | A MobileC agency | |
| id | a synchronization variable id |
The following example demonstrates the agent-space version of this function.
Definition at line 1359 of file libmc.c.
References syncListNode_s::cond, COND_WAIT, ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, MC_ERR_NOT_FOUND, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, syncListNode_s::signalled, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_CondWait_chdl().
Performs a deep-copy of an agent structure.
| agent_out | A pointer to the agent to copy to. | |
| agent_in | The agent to copy |
Definition at line 1409 of file libmc.c.
References agent_Copy(), and MC_SUCCESS.
| EXPORTMC int MC_DeleteAgent | ( | MCAgent_t | agent | ) |
Stop and remove an agent.
| agent | An agent in any state (running, waiting, etc) |
Definition at line 1416 of file libmc.c.
References agent_CmpName(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, CHECK_NULL, ListDeleteCB(), ListWRLock(), ListWRUnlock(), MC_ERR_INVALID, MC_ERR_INVALID_ARGS, agent_s::mc_platform, MC_SUCCESS, MC_TerminateAgent(), agent_s::name, strdup, and agent_s::wg_code.
Referenced by MC_DeleteAgent_chdl().
Stop and remove an agent in the same workgroup.
| calling_agent | The calling agent | |
| agent | An agent in any state (running, waiting, etc) |
Definition at line 1446 of file libmc.c.
References agent_CmpName(), agent_Destroy(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, CHECK_NULL, ListDeleteCB(), ListWRLock(), ListWRUnlock(), MC_ERR_INVALID, MC_ERR_INVALID_ARGS, agent_s::mc_platform, MC_SUCCESS, MC_TerminateAgentWG(), agent_s::name, strdup, and agent_s::wg_code.
Referenced by MC_DeleteAgentWG_chdl().
| int MC_DestroyServiceSearchResult | ( | char ** | agentName, | |
| char ** | serviceName, | |||
| int * | agentID, | |||
| int | numResult | |||
| ) |
Free memory allocated by a Service Search operation.
| agentName | agent names returned by a search operation. | |
| serviceName | service names return by a search operation. | |
| agentID | list of agent id's returned by a search operation. | |
| numResult | The number of hits returned by a search operation. |
Definition at line 1483 of file libmc.c.
Referenced by MC_DestroyServiceSearchResult_chdl().
| EXPORTMC int MC_End | ( | MCAgency_t | attr | ) |
End an agency.
| attr | A running agency |
Definition at line 1532 of file libmc.c.
References mc_platform_s::acc, mc_platform_s::ams, buf, mc_platform_s::cmd_prompt, COND_BROADCAST, COND_SIGNAL, mc_platform_s::connection_queue, mc_platform_s::df, GET_THREAD_MODE, agency_s::hostName, ListWRLock(), ListWRUnlock(), agency_s::mc_platform, mc_platform_Destroy(), MC_THREAD_ACC, MC_THREAD_AMS, MC_THREAD_CP, MC_THREAD_DF, mc_platform_s::message_queue, MUTEX_LOCK, MUTEX_UNLOCK, agency_s::portno, mc_platform_s::quit, mc_platform_s::quit_cond, mc_platform_s::quit_lock, send, cmd_prompt_s::thread, THREAD_CANCEL, THREAD_JOIN, and agency_s::threads.
Referenced by MC_End_chdl().
| EXPORTMC MCAgent_t MC_FindAgentByID | ( | MCAgency_t | attr, | |
| int | ID | |||
| ) |
Find an agent by its id.
| attr | the agency to search | |
| ID | the id to search for |
Definition at line 1652 of file libmc.c.
References agent_CmpID(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListRDLock(), ListRDUnlock(), ListSearchCB(), and agency_s::mc_platform.
Referenced by MC_FindAgentByID_chdl().
| EXPORTMC MCAgent_t MC_FindAgentByName | ( | MCAgency_t | attr, | |
| const char * | name | |||
| ) |
Find an agent by its name.
| attr | a running agency | |
| name | name to search for |
Definition at line 1631 of file libmc.c.
References agent_CmpName(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListRDLock(), ListRDUnlock(), ListSearchCB(), and agency_s::mc_platform.
Referenced by MC_AclSend(), MC_DeleteAgent_chdl(), MC_DeleteAgentWG_chdl(), MC_FindAgentByName_chdl(), MC_TerminateAgent_chdl(), and MC_TerminateAgentWG_chdl().
| EXPORTMC void* MC_GetAgentExecEngine | ( | MCAgent_t | agent | ) |
Retrieve an agent's Ch interpreter.
| agent | a valid agent |
Definition at line 1717 of file libmc.c.
References agent_s::agent_interp.
| EXPORTMC int MC_GetAgentID | ( | MCAgent_t | agent | ) |
Retrieve an agent's id.
Definition at line 1723 of file libmc.c.
References agent_s::id.
Referenced by MC_GetAgentID_chdl().
| EXPORTMC char* MC_GetAgentName | ( | MCAgent_t | agent | ) |
Definition at line 1731 of file libmc.c.
References agent_s::lock, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::name.
Referenced by MC_GetAgentName_chdl().
| EXPORTMC int MC_GetAgentNumTasks | ( | MCAgent_t | agent | ) |
Retrive the number of tasks an agent has.
Definition at line 1814 of file libmc.c.
References agent_s::datastate, and agent_datastate_s::number_of_tasks.
Referenced by MC_GetAgentNumTasks_chdl().
| EXPORTMC int MC_GetAgentReturnData | ( | MCAgent_t | agent, | |
| int | task_num, | |||
| void ** | data, | |||
| int * | dim, | |||
| int ** | extent | |||
| ) |
Get an agent's return data.
| agent | a valid agent | |
| task_num | the task for which to retrieve the return data. The task must already be completed. | |
| data | the return data. May be multi dimensional array. | |
| dim | the number of dimensions of the return array. | |
| extent | the extent of each one of the array dimensions. |
This file demonstrates the retrieval of agent return data from an agent
This is the agent which gets the data
Definition at line 1749 of file libmc.c.
References agent_task_s::agent_return_data, interpreter_variable_data_s::array_dim, interpreter_variable_data_s::array_extent, CH_DATATYPE_SIZE, interpreter_variable_data_s::data_type, agent_s::datastate, agent_datastate_s::number_of_tasks, and agent_datastate_s::tasks.
| EXPORTMC int MC_GetAgents | ( | MCAgency_t | attr, | |
| MCAgent_t ** | agents, | |||
| int * | num_agents, | |||
| unsigned int | agent_status_flags | |||
| ) |
Get a list of agents that match a certain agent status.
| agency | A handle to a running Mobile-C agency | |
| agents | The address of an uninitialized pointer to an agent. An array of agents will be allocated, which will need to be freed by the user. | |
| num_agents | A pointer to an integer. The integer will be filled with the number of agents allocated for the 'agents' variable. | |
| agent_status_flags | These contain flags of agent statuses. For instance, if a user wishes to retrieve all agents with either the status MC_WAIT_CH or MC_AGENT_NEUTRAL, they may use an agent_status_flag of ((1<<MC_WAIT_CH) | (1<<MC_AGENT_NEUTRAL)). All valid agent statuses are enumerated in the enumeration MC_AgentStatus_e, located in libmc.h. |
Definition at line 1830 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, agent_s::agent_status, ListRDLock(), ListRDUnlock(), ListSearch(), and agency_s::mc_platform.
| EXPORTMC int MC_GetAgentStatus | ( | MCAgent_t | agent | ) |
Get an agent's current status.
Definition at line 1693 of file libmc.c.
References agent_s::agent_status, agent_s::agent_status_lock, agent_s::lock, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by MC_GetAgentStatus_chdl().
| EXPORTMC enum MC_AgentType_e MC_GetAgentType | ( | MCAgent_t | agent | ) |
Get an agent's type.
Definition at line 1820 of file libmc.c.
References agent_s::agent_type.
| EXPORTMC char* MC_GetAgentXMLString | ( | MCAgent_t | agent | ) |
Get an agent's xml string.
Definition at line 1705 of file libmc.c.
References agent_s::datastate, mxmlSaveAllocString(), and agent_datastate_s::xml_agent_root.
Referenced by MC_GetAgentXMLString_chdl().
| EXPORTMC int MC_GetAllAgents | ( | MCAgency_t | attr, | |
| MCAgent_t ** | agents, | |||
| int * | num_agents | |||
| ) |
Get all of the agents on an agency.
| agency | A handle to a running Mobile-C agency | |
| agents | The address of an uninitialized pointer to an agent. An array of agents will be allocated, which will need to be freed by the user. | |
| num_agents | A pointer to an integer. The integer will be filled with the number of agents allocated for the 'agents' variable. |
Definition at line 1876 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListGetSize(), ListRDLock(), ListRDUnlock(), ListSearch(), and agency_s::mc_platform.
| EXPORTMC int MC_GetNumAgents | ( | MCAgency_t | attr, | |
| int * | num_agents | |||
| ) |
Get the number of agents residing on an agency.
| attr | A handle to a running Mobile-C agency | |
| num_agents | A pointer to an integer to fill with the number of agents |
Definition at line 1907 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListGetSize(), ListRDLock(), ListRDUnlock(), and agency_s::mc_platform.
| EXPORTMC int MC_HaltAgency | ( | MCAgency_t | agency | ) |
Halt an agency: Do not process new entries in queues.
| agency | A handle to a running MobileC agency. |
Definition at line 1920 of file libmc.c.
References mc_platform_s::giant, mc_platform_s::giant_lock, agency_s::mc_platform, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by MC_HaltAgency_chdl().
| EXPORTMC MCAgency_t MC_Initialize | ( | int | port, | |
| MCAgencyOptions_t * | options | |||
| ) |
Initialize and start a MobileC agency.
| port | the TCP port the agency should bind to | |
| options | initialized MobileC options or NULL for default options |
Definition at line 1929 of file libmc.c.
References agency_s::agentInitCallback, agency_s::agentInitUserData, MCAgencyOptions_s::bluetooth, agency_s::bluetooth, buf, MCAgencyOptions_s::ch_options, agency_s::client, MCAgencyOptions_s::default_agent_status, agency_s::default_agentstatus, f, agency_s::hostName, MCAgencyOptions_s::initialized, MCAgencyOptions_s::initInterps, agency_s::initInterps, agency_s::known_host_filename, MCAgencyOptions_s::known_host_filename, MC_InitializeAgencyOptions(), MC_INITIALIZED_CODE, agency_s::mc_platform, mc_platform_Initialize(), MC_THREAD_ALL, MCAgencyOptions_s::passphrase, agency_s::portno, agency_s::priv_key_filename, MCAgencyOptions_s::priv_key_filename, read_encrypted_file(), agency_s::server, MCAgencyOptions_s::stack_size, agency_s::stack_size, strdup, MCAgencyOptions_s::threads, and agency_s::threads.
| EXPORTMC int MC_InitializeAgencyOptions | ( | struct MCAgencyOptions_s * | options | ) |
Initialize MobileC options.
| options | options to initialize. |
Definition at line 2049 of file libmc.c.
References MCAgencyOptions_s::bluetooth, MCAgencyOptions_s::default_agent_status, MCAgencyOptions_s::initialized, MCAgencyOptions_s::initInterps, MCAgencyOptions_s::known_host_filename, MC_INITIALIZED_CODE, MC_THREAD_ALL, MC_WAIT_CH, MCAgencyOptions_s::modified, MCAgencyOptions_s::passphrase, MCAgencyOptions_s::priv_key_filename, MCAgencyOptions_s::stack_size, and MCAgencyOptions_s::threads.
Referenced by MC_Initialize().
| EXPORTMC int MC_LoadAgentFromFile | ( | MCAgency_t | attr, | |
| const char * | filename | |||
| ) |
Load an agent from a file into an agency.
| agency | A valid and running Mobile-C agency | |
| filename | Filename containing the agent to load |
Definition at line 2072 of file libmc.c.
References buf, ListAdd(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, message_Destroy(), message_InitializeFromString(), message_New(), mc_platform_s::message_queue, MXML_DESCEND, mxmlFindElement(), mxmlLoadString(), message_s::to_address, message_s::xml_payload, and message_s::xml_root.
| EXPORTMC int MC_MainLoop | ( | MCAgency_t | attr | ) |
Wait indefinitely.
Definition at line 2923 of file libmc.c.
References COND_WAIT, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, mc_platform_s::quit, mc_platform_s::quit_cond, and mc_platform_s::quit_lock.
| EXPORTMC int MC_MigrateAgent | ( | MCAgent_t | agent, | |
| const char * | hostname, | |||
| int | port | |||
| ) |
Migrates a running agent to another host.
| agent | The agent to migrate | |
| hostname | The new host to migrate the agent to | |
| port | The new port to migrate the agent to |
Definition at line 2146 of file libmc.c.
References agent_s::datastate, agent_datastate_s::progress_modifier, agent_task_s::server_name, agent_datastate_s::task_progress, and agent_datastate_s::tasks.
Referenced by MC_MigrateAgent_chdl().
| EXPORTMC int MC_MutexLock | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Locks a MobileC synchronization variable as a mutex.
| attr | a MobileC agency handle | |
| id | the synchronization variable id to lock |
Consider the following agents, which use the agent-space version of this api function. Note that the 'sleep' agent is sent first, followed by the 'wake' agent.
Definition at line 2168 of file libmc.c.
References ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, agency_s::mc_platform, MUTEX_LOCK, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_MutexLock_chdl().
| EXPORTMC int MC_MutexUnlock | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Definition at line 2185 of file libmc.c.
References ListRDLock(), ListRDUnlock(), ListSearchCB(), syncListNode_s::lock, agency_s::mc_platform, MUTEX_UNLOCK, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_MutexUnlock_chdl().
| EXPORTMC int MC_PrintAgentCode | ( | MCAgent_t | agent | ) |
Prints an agents code to stdout.
Definition at line 2202 of file libmc.c.
References agent_datastate_s::agent_code, agent_s::datastate, agent_s::lock, MUTEX_LOCK, MUTEX_UNLOCK, agent_datastate_s::number_of_tasks, and agent_datastate_s::task_progress.
Referenced by MC_PrintAgentCode_chdl().
| EXPORTMC int MC_QueueRDLock | ( | MCAgency_t | agency, | |
| enum MC_QueueIndex_e | queue | |||
| ) |
Lock an agency queue for reading. Prevents other threads from writing.
Definition at line 2218 of file libmc.c.
References ListRDLock(), agency_s::mc_platform, and mc_platform_GetQueue().
| EXPORTMC int MC_QueueRDUnlock | ( | MCAgency_t | agency, | |
| enum MC_QueueIndex_e | queue | |||
| ) |
Unlock an agency queue that was previously locked for reading.
Definition at line 2230 of file libmc.c.
References ListRDUnlock(), agency_s::mc_platform, and mc_platform_GetQueue().
| EXPORTMC int MC_QueueWRLock | ( | MCAgency_t | agency, | |
| enum MC_QueueIndex_e | queue | |||
| ) |
Lock an agency queue for writing. Prevents other threads from reading and writing.
Definition at line 2242 of file libmc.c.
References ListWRLock(), agency_s::mc_platform, and mc_platform_GetQueue().
| EXPORTMC int MC_QueueWRUnlock | ( | MCAgency_t | agency, | |
| enum MC_QueueIndex_e | queue | |||
| ) |
Unlock an agency queue that was previously locked for writing.
Definition at line 2254 of file libmc.c.
References ListWRUnlock(), agency_s::mc_platform, and mc_platform_GetQueue().
| EXPORTMC int MC_RegisterService | ( | MCAgency_t | agency, | |
| MCAgent_t | agent, | |||
| int | agentID, | |||
| const char * | agentName, | |||
| char ** | serviceNames, | |||
| int | numServices | |||
| ) |
Register a new service with the Directory Facilitator.
| agency | a MobileC agency handle | |
| agent | (OPTIONAL: See note) a MobileC agent | |
| agentID | (OPTIONAL: See note) a MobileC agent id | |
| agentName | (OPTIONAL: See note) a MobileC agent name | |
| serviceNames | an array of character strings of service names | |
| numServices | the number of services described in 'serviceNames' |
Definition at line 2266 of file libmc.c.
References CHECK_NULL, mc_platform_s::df, df_AddRequest(), df_request_list_node_New(), agent_s::id, MC_ERR_INVALID_ARGS, MC_ERR_MEMORY, agency_s::mc_platform, MUTEX_INIT, MUTEX_T, and agent_s::name.
Referenced by MC_RegisterService_chdl().
| EXPORTMC int MC_ResetSignal | ( | MCAgency_t | attr | ) |
Reset a MobileC signal.
Definition at line 2405 of file libmc.c.
References COND_SIGNAL, mc_platform_s::giant, mc_platform_s::giant_cond, mc_platform_s::giant_lock, MC_NO_SIGNAL, agency_s::mc_platform, mc_platform_s::MC_signal, MUTEX_LOCK, and MUTEX_UNLOCK.
| EXPORTMC int MC_ResumeAgency | ( | MCAgency_t | agency | ) |
Resumes a halted agency.
| agency | An agency previously halted with the MC_HaltAgency() function. |
Definition at line 2345 of file libmc.c.
References mc_platform_s::giant, mc_platform_s::giant_lock, agency_s::mc_platform, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by MC_ResumeAgency_chdl().
| EXPORTMC MCAgent_t MC_RetrieveAgent | ( | MCAgency_t | attr | ) |
Retrieves the oldest agent from an agency.
Definition at line 2354 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, agent_s::agent_status, agent_s::agent_status_lock, ListRDLock(), ListRDUnlock(), ListSearch(), MC_AGENT_NEUTRAL, agency_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, and list_s::size.
Referenced by MC_RetrieveAgent_chdl().
| EXPORTMC char* MC_RetrieveAgentCode | ( | MCAgent_t | agent | ) |
Retrieves an agent's Ch code.
Definition at line 2389 of file libmc.c.
References agent_datastate_s::agent_code, buf, agent_s::datastate, agent_s::lock, MUTEX_LOCK, MUTEX_UNLOCK, and agent_datastate_s::task_progress.
Referenced by MC_RetrieveAgentCode_chdl().
| EXPORTMC int MC_SearchForService | ( | MCAgency_t | attr, | |
| const char * | searchString, | |||
| char *** | agentNames, | |||
| char *** | serviceNames, | |||
| int ** | agentIDs, | |||
| int * | numResults | |||
| ) |
Search the directory facilitator for a service.
| attr | (input) a MobileC agency handle | |
| searchString | (input) substring to search services for | |
| agentNames | (return) array of agent names with matching services | |
| serviceNames | (return) array of matching service names | |
| agentIDs | (return) array of matching agent IDs | |
| numResults | (return) number of matching results |
Definition at line 2416 of file libmc.c.
References CHECK_NULL, COND_SLEEP_ACTION, mc_platform_s::df, df_AddRequest(), df_request_list_node_Destroy(), df_request_list_node_New(), df_request_search_Destroy(), df_request_search_New(), MC_ERR_MEMORY, agency_s::mc_platform, MC_SUCCESS, and search.
Referenced by MC_SearchForService_chdl().
| EXPORTMC int MC_SemaphorePost | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Post to a MobileC synchronization variable semaphore.
| attr | a MobileC agency handle | |
| id | the synchronization variable id to post to |
Definition at line 2466 of file libmc.c.
References ListRDLock(), ListRDUnlock(), ListSearchCB(), agency_s::mc_platform, syncListNode_s::sem, SEMAPHORE_POST, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_SemaphorePost_chdl().
| EXPORTMC int MC_SemaphoreWait | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Decreases a MobileC synchronization variable semaphore count by one.
| attr | a MobileC agency handle | |
| id | synchronization variable id to wait on |
Definition at line 2483 of file libmc.c.
References ListRDLock(), ListRDUnlock(), ListSearchCB(), agency_s::mc_platform, syncListNode_s::sem, SEMAPHORE_WAIT, mc_platform_s::syncList, and syncListNode_CmpID().
Referenced by MC_SemaphoreWait_chdl().
| EXPORTMC int MC_SendAgent | ( | MCAgency_t | attr, | |
| const char * | message | |||
| ) |
Sends an agent migration message.
| attr | a MobileC agency handle | |
| message | a valid MobileC xml agent migration message |
Definition at line 2510 of file libmc.c.
References agent_Initialize(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, agent_s::agent_status, agent_s::agent_status_cond, agent_s::agent_status_lock, mc_platform_s::ams, COND_BROADCAST, ListAdd(), ListWRLock(), ListWRUnlock(), MC_ERR, agency_s::mc_platform, MC_WAIT_MESSGSEND, message_Destroy(), message_InitializeFromString(), message_New(), MUTEX_LOCK, and MUTEX_UNLOCK.
| EXPORTMC int MC_SendAgentFile | ( | MCAgency_t | attr, | |
| const char * | filename | |||
| ) |
Sends an agent migration message.
| attr | a MobileC agency handle | |
| filename | file containing a valid MobileC xml agent migration message |
Definition at line 2565 of file libmc.c.
References agent_Initialize(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, agent_s::agent_status, agent_s::agent_status_cond, agent_s::agent_status_lock, mc_platform_s::ams, buf, COND_BROADCAST, ListAdd(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, MC_WAIT_MESSGSEND, message_Destroy(), message_InitializeFromString(), message_New(), MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by handler_SEND().
| EXPORTMC int MC_SendAgentMigrationMessage | ( | MCAgency_t | attr, | |
| const char * | message, | |||
| const char * | hostname, | |||
| int | port | |||
| ) |
Sends an agent migration message.
| attr | a MobileC agency handle | |
| message | a valid MobileC xml agent migration message | |
| hostname | host to send the message to | |
| port | port to send the message to |
Definition at line 2640 of file libmc.c.
References ListAdd(), ListWRLock(), ListWRUnlock(), MC_ERR, agency_s::mc_platform, message_Destroy(), message_InitializeFromString(), message_New(), and mc_platform_s::message_queue.
Referenced by MC_SendAgentMigrationMessage_chdl().
| EXPORTMC int MC_SendAgentMigrationMessageFile | ( | MCAgency_t | attr, | |
| const char * | filename, | |||
| const char * | hostname, | |||
| int | port | |||
| ) |
Sends an agent migration message.
| attr | a MobileC agency handle | |
| filename | file containing a valid MobileC xml agent migration message | |
| hostname | hostname to send the agent to | |
| port | port to send the agent to |
Definition at line 2677 of file libmc.c.
References agent_Initialize(), mc_platform_s::agent_processing, mc_platform_s::agent_queue, agent_s::agent_status, agent_s::agent_status_cond, agent_s::agent_status_lock, mc_platform_s::ams, buf, COND_BROADCAST, ListAdd(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, MC_WAIT_MESSGSEND, message_Destroy(), message_InitializeFromString(), message_New(), MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by MC_SendAgentMigrationMessageFile_chdl().
| EXPORTMC int MC_SetAgentStatus | ( | MCAgent_t | agent, | |
| enum MC_AgentStatus_e | status | |||
| ) |
Set an agent's status.
| agent | a MobileC agent | |
| status | agent status of type 'enum MC_AgentStatus_e' |
Definition at line 2764 of file libmc.c.
References agent_s::agent_status, agent_s::agent_status_cond, agent_s::agent_status_lock, mc_platform_s::ams, COND_BROADCAST, COND_SIGNAL, agent_s::lock, agent_s::mc_platform, MUTEX_LOCK, MUTEX_UNLOCK, and agent_s::orphan.
Referenced by MC_SetAgentStatus_chdl().
| EXPORTMC int MC_SetDefaultAgentStatus | ( | MCAgency_t | agency, | |
| enum MC_AgentStatus_e | status | |||
| ) |
Sets default incoming agent status.
| agency | a MobileC agency handle | |
| status | the status to set all incoming agents |
Definition at line 2782 of file libmc.c.
References mc_platform_s::default_agentstatus, and agency_s::mc_platform.
Referenced by MC_SetDefaultAgentStatus_chdl().
| EXPORTMC int MC_SetThreadOff | ( | MCAgencyOptions_t * | options, | |
| enum MC_ThreadIndex_e | index | |||
| ) |
Sets a MobileC thread to "off" status.
| options | MobileC options previously initialized with MC_InitializeAgencyOptions() | |
| index | the thread to set |
Definition at line 2809 of file libmc.c.
References SET_THREAD_OFF, and MCAgencyOptions_s::threads.
| EXPORTMC int MC_SetThreadOn | ( | MCAgencyOptions_t * | options, | |
| enum MC_ThreadIndex_e | index | |||
| ) |
Sets a MobileC thread to "on" status.
| options | MobileC options previously initialized with MC_InitializeAgencyOptions() | |
| index | the thread to set |
Definition at line 2792 of file libmc.c.
References SET_THREAD_ON, and MCAgencyOptions_s::threads.
| EXPORTMC int MC_SetThreadsAllOff | ( | MCAgencyOptions_t * | options | ) |
Set all MobileC threads to 'off' status.
| options | a MobileC options structure initialized with with the MC_InitializeAgencyOptions() function. |
Definition at line 2816 of file libmc.c.
References MC_THREAD_ALL, SET_THREAD_OFF, and MCAgencyOptions_s::threads.
| EXPORTMC int MC_SetThreadsAllOn | ( | MCAgencyOptions_t * | options | ) |
Set all Mobile-C threads on.
| options | MobileC options structure, initialized with MC_InitializeAgencyOptions() |
Definition at line 2799 of file libmc.c.
References MC_THREAD_ALL, SET_THREAD_ON, and MCAgencyOptions_s::threads.
| EXPORTMC int MC_Steer | ( | MCAgency_t | attr, | |
| int(*)(void *data) | funcptr, | |||
| void * | arg | |||
| ) |
Set up a steerable algorithm.
| attr | a MobileC agency handle | |
| funcptr | a function pointer to the algorithm | |
| arg | an argument for the algorithm function |
Definition at line 2826 of file libmc.c.
References agency_s::mc_platform, MC_RESTART, MC_RUN, mc_platform_s::MC_steer_command, mc_platform_s::MC_steer_lock, MUTEX_LOCK, and MUTEX_UNLOCK.
| EXPORTMC enum MC_SteerCommand_e MC_SteerControl | ( | void | ) |
The MobileC user-algorithm steering function.
Definition at line 2845 of file libmc.c.
References COND_WAIT, mc_platform_s::MC_steer_command, mc_platform_s::MC_steer_cond, mc_platform_s::MC_steer_lock, MC_SUSPEND, MUTEX_LOCK, and MUTEX_UNLOCK.
| EXPORTMC int MC_SyncDelete | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Deletes a previously initialized synchronization variable.
| attr | a MobileC agency handle | |
| id | the sync variable id to delete |
Definition at line 2861 of file libmc.c.
References agency_s::mc_platform, mc_platform_s::syncList, and syncListDelete().
Referenced by MC_SyncDelete_chdl().
| EXPORTMC int MC_SyncInit | ( | MCAgency_t | attr, | |
| int | id | |||
| ) |
Initializes a new MobileC synchronization variable.
| attr | a MobileC agency handle | |
| id | the requested sync variable id |
Definition at line 2867 of file libmc.c.
References syncListNode_s::id, ListSearchCB(), ListWRLock(), ListWRUnlock(), agency_s::mc_platform, mc_platform_s::syncList, syncListAddNode(), syncListNode_CmpID(), and syncListNodeNew().
Referenced by MC_SyncInit_chdl().
| EXPORTMC int MC_TerminateAgent | ( | MCAgent_t | agent | ) |
Halt a running agent.
Definition at line 2893 of file libmc.c.
References agent_s::agent_interp, agent_s::lock, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by ams_ManageAgentList(), MC_DeleteAgent(), and MC_TerminateAgent_chdl().
Definition at line 2905 of file libmc.c.
References agent_s::agent_interp, MC_ERR_INVALID_ARGS, and agent_s::wg_code.
Referenced by MC_DeleteAgentWG(), and MC_TerminateAgentWG_chdl().
| EXPORTMC int MC_WaitAgent | ( | MCAgency_t | attr | ) |
Wait indefinitely.
Definition at line 2934 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListGetSize(), ListRDLock(), ListRDUnlock(), ListRDWait(), and agency_s::mc_platform.
| EXPORTMC MCAgent_t MC_WaitRetrieveAgent | ( | MCAgency_t | attr | ) |
Wait and retrieve an agent.
Definition at line 2952 of file libmc.c.
References mc_platform_s::agent_processing, mc_platform_s::agent_queue, ListGetSize(), ListRDLock(), ListRDUnlock(), ListSearch(), agency_s::mc_platform, MC_RECV_AGENT, and MC_WaitSignal().
| EXPORTMC int MC_WaitSignal | ( | MCAgency_t | attr, | |
| int | signals | |||
| ) |
Wait for a MobileC signal.
| attr | a MobileC agency handle | |
| signals | a flag of signals to wait for, of type 'enum MC_Signal_e' |
Definition at line 2972 of file libmc.c.
References COND_WAIT, mc_platform_s::giant, mc_platform_s::giant_lock, agency_s::mc_platform, mc_platform_s::MC_signal, mc_platform_s::MC_signal_cond, mc_platform_s::MC_signal_lock, MUTEX_LOCK, and MUTEX_UNLOCK.
Referenced by MC_WaitRetrieveAgent().
1.6.3