async_task.h

Go to the documentation of this file.

/*
 * async_task.h
 *
 *  Created on: 3 May 2017
 *      Author: billy
 */
 
#ifndef CORE_SERVER_TASK_INCLUDE_ASYNC_TASK_H_
#define CORE_SERVER_TASK_INCLUDE_ASYNC_TASK_H_
 
#include "grassroots_task_library.h"
#include "typedefs.h"
#include "linked_list.h"
#include "sync_data.h"
#include "memory_allocations.h"
#include "event_consumer.h"
#include "operation.h"
 
struct AsyncTasksManager;
 
typedef struct AsyncTask
{
  char *at_name_s;
 
  struct SyncData *at_sync_data_p;
 
  MEM_FLAG at_sync_data_mem;
 
  void *(*at_run_fn) (void *data_p);
 
  void *at_data_p;
 
  EventConsumer *at_consumer_p;
 
  MEM_FLAG at_consumer_mem;
 
 
 
  struct AsyncTasksManager *at_manager_p;
 
} AsyncTask;
 
 
typedef struct AsyncTaskNode
{
  ListItem atn_node;
 
  AsyncTask *atn_task_p;
 
  MEM_FLAG atn_mem;
} AsyncTaskNode;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_TASK_API AsyncTask *AllocateAsyncTask (const char *name_s, struct AsyncTasksManager *manager_p, bool add_flag);
 
 
GRASSROOTS_TASK_API void FreeAsyncTask (AsyncTask *task_p);
 
 
GRASSROOTS_TASK_API bool InitialiseAsyncTask (AsyncTask *task_p, const char *name_s, struct AsyncTasksManager *manager_p, bool add_flag);
 
 
GRASSROOTS_TASK_API void ClearAsyncTask (AsyncTask *task_p);
 
 
 
 
GRASSROOTS_TASK_API void CloseAsyncTask (AsyncTask *task_p);
 
 
GRASSROOTS_TASK_API bool SetAsyncTaskSyncData (AsyncTask *task_p, SyncData *sync_data_p, MEM_FLAG mem);
 
GRASSROOTS_TASK_API void SetAsyncTaskRunData (AsyncTask *task_p, void *(*run_fn) (void *data_p), void *data_p);
 
 
 
GRASSROOTS_TASK_API bool IsAsyncTaskRunning (const AsyncTask *task_p);
 
 
GRASSROOTS_TASK_API bool RunAsyncTask (AsyncTask *task_p);
 
 
GRASSROOTS_TASK_API  bool CloseAllAsyncTasks (void);
 
 
GRASSROOTS_TASK_API AsyncTaskNode *AllocateAsyncTaskNode (AsyncTask *task_p, MEM_FLAG mem);
 
 
GRASSROOTS_TASK_API void FreeAsyncTaskNode (ListItem *node_p);
 
 
GRASSROOTS_TASK_API void SetAsyncTaskConsumer (AsyncTask *task_p, EventConsumer *consumer_p, MEM_FLAG mem);
 
 
GRASSROOTS_TASK_API void RunEventConsumerFromAsyncTask (AsyncTask *task_p);
 
 
 
GRASSROOTS_TASK_API OperationStatus RunProcess (const char *const command_line_s);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* CORE_SERVER_TASK_INCLUDE_ASYNC_TASK_H_ */