service_job_set_iterator.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
/*
 * service_job_set_iterator.h
 *
 *  Created on: 19 Jan 2016
 *      Author: tyrrells
 */
 
#ifndef SERVICE_JOB_SET_ITERATOR_H_
#define SERVICE_JOB_SET_ITERATOR_H_
 
#include "grassroots_service_library.h"
#include "service_job.h"
 
 
typedef struct ServiceJobSetIterator
{
  ServiceJobSet *sjsi_job_set_p;
 
  ServiceJobNode *sjs_current_node_p;
} ServiceJobSetIterator;
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
GRASSROOTS_SERVICE_API ServiceJobSetIterator *AllocateServiceJobSetIterator (ServiceJobSet *set_p);
 
 
GRASSROOTS_SERVICE_API void InitServiceJobSetIterator (ServiceJobSetIterator *iterator_p, ServiceJobSet *set_p);
 
GRASSROOTS_SERVICE_API void FreeServiceJobSetIterator (ServiceJobSetIterator *iterator_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *GetNextServiceJobFromServiceJobSetIterator (ServiceJobSetIterator *iterator_p);
 
 
GRASSROOTS_SERVICE_API bool HasServiceJobSetIteratorFinished (const ServiceJobSetIterator *iterator_p);
 
 
#ifdef __cplusplus
  }
#endif
 
 
#endif /* SERVICE_JOB_SET_ITERATOR_H_ */