Grassroots Infrastructure
The Grassroots Infrastructure is a suite of computing tools to help users and developers use scientific data infrastructure that can easily be interconnected.
AsyncTasksManagerEventConsumer Struct Reference

A datatype that has an EventConsumer and a pointer to the AsyncTasksManager that owns it. More...

#include <async_tasks_manager.h>

Collaboration diagram for AsyncTasksManagerEventConsumer:
[legend]

Public Member Functions

AsyncTasksManagerEventConsumerAllocateAsyncTasksManagerEventConsumer (void(*consumer_fn)(EventConsumer *consumer_p, struct AsyncTask *task_p), AsyncTasksManager *manager_p)
 Create a new AsyncTasksManagerEventConsumer and store it in the given AsyncTasksManager. More...
 
void FreeAsyncTasksManagerEventConsumer (AsyncTasksManagerEventConsumer *consumer_p)
 Free an AsyncTasksManagerEventConsumer. More...
 

Data Fields

EventConsumer atmec_base_consumer
 The EventConsumer. More...
 
AsyncTasksManageratmec_tasks_manager_p
 The AsyncTasksManager that owns this AsyncTasksManagerEventConsumer. More...
 

Detailed Description

A datatype that has an EventConsumer and a pointer to the AsyncTasksManager that owns it.

Member Function Documentation

◆ AllocateAsyncTasksManagerEventConsumer()

AsyncTasksManagerEventConsumer * AllocateAsyncTasksManagerEventConsumer ( void(*)(EventConsumer *consumer_p, struct AsyncTask *task_p)  consumer_fn,
AsyncTasksManager manager_p 
)

Create a new AsyncTasksManagerEventConsumer and store it in the given AsyncTasksManager.

Parameters
consumer_fnThe callback function that the new AsyncTasksManagerEventConsumer's atmec_base_consumer will use.
manager_pThe AsyncTasksManager that will store this AsyncTasksManagerEventConsumer.
Returns
The new AsyncTasksManagerEventConsumer or NULL upon error.

◆ FreeAsyncTasksManagerEventConsumer()

void FreeAsyncTasksManagerEventConsumer ( AsyncTasksManagerEventConsumer consumer_p)

Free an AsyncTasksManagerEventConsumer.

Parameters
consumer_pThe AsyncTasksManagerEventConsumer to free.

Field Documentation

◆ atmec_base_consumer

EventConsumer atmec_base_consumer

◆ atmec_tasks_manager_p

AsyncTasksManager* atmec_tasks_manager_p

The documentation for this struct was generated from the following file: