ServiceJobSetIterator Struct Reference

A datatype allowing easy traversal over all of the ServiceJobs within a ServiceJobSet. More...

#include <service_job_set_iterator.h>

Collaboration diagram for ServiceJobSetIterator:
[legend]

Public Member Functions

ServiceJobSetIteratorAllocateServiceJobSetIterator (ServiceJobSet *set_p)
 Allocate a ServiceJobSetIterator. More...
 
void InitServiceJobSetIterator (ServiceJobSetIterator *iterator_p, ServiceJobSet *set_p)
 Initialise a ServiceJobSetIterator to point to the first entry in a given ServiceJobSet. More...
 
void FreeServiceJobSetIterator (ServiceJobSetIterator *iterator_p)
 Free a ServiceJobSetIterator. More...
 
ServiceJobGetNextServiceJobFromServiceJobSetIterator (ServiceJobSetIterator *iterator_p)
 Get the next ServiceJob from the Iterator. More...
 
bool HasServiceJobSetIteratorFinished (const ServiceJobSetIterator *iterator_p)
 Has a ServiceJobSetIterator parsed all of the entries in a ServiceJobSet. More...
 

Data Fields

ServiceJobSetsjsi_job_set_p
 The ServiceJobSet to traverse. More...
 
ServiceJobNodesjs_current_node_p
 The current position in the entries of the ServiceJobSet. More...
 

Detailed Description

A datatype allowing easy traversal over all of the ServiceJobs within a ServiceJobSet.

Examples
long_running_service.c.

Member Function Documentation

◆ AllocateServiceJobSetIterator()

ServiceJobSetIterator * AllocateServiceJobSetIterator ( ServiceJobSet set_p)

Allocate a ServiceJobSetIterator.

Parameters
set_pThe ServiceJobSet to iterate over
Returns
The ServiceJobSetIterator or NULL upon error.

◆ InitServiceJobSetIterator()

void InitServiceJobSetIterator ( ServiceJobSetIterator iterator_p,
ServiceJobSet set_p 
)

Initialise a ServiceJobSetIterator to point to the first entry in a given ServiceJobSet.

Parameters
iterator_pThe ServiceJobSetIterator to initialise.
set_pThe ServiceJobSet to iterate over.
Examples
long_running_service.c.

◆ FreeServiceJobSetIterator()

void FreeServiceJobSetIterator ( ServiceJobSetIterator iterator_p)

Free a ServiceJobSetIterator.

Parameters
iterator_pThe ServiceJobSetIterator to free.

◆ GetNextServiceJobFromServiceJobSetIterator()

ServiceJob * GetNextServiceJobFromServiceJobSetIterator ( ServiceJobSetIterator iterator_p)

Get the next ServiceJob from the Iterator.

Parameters
iterator_pThe ServiceJobSetIterator to get the ServiceJob from.
Returns
The next ServiceJob or NULL if all of the ServiceJobs in the ServiceJobSet have been read.
Examples
long_running_service.c.

◆ HasServiceJobSetIteratorFinished()

bool HasServiceJobSetIteratorFinished ( const ServiceJobSetIterator iterator_p)

Has a ServiceJobSetIterator parsed all of the entries in a ServiceJobSet.

Parameters
iterator_pThe ServiceJobSetIterator to check.
Returns
true if the end of the ServiceJobSet has been reached, false otherwise.

Field Documentation

◆ sjsi_job_set_p

ServiceJobSet* sjsi_job_set_p

The ServiceJobSet to traverse.

◆ sjs_current_node_p

ServiceJobNode* sjs_current_node_p

The current position in the entries of the ServiceJobSet.


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