view sciworkerd/sciworkerd.h @ 60:3804a2ab60ec

misc: documentation improvements
author David Demelier <markand@malikania.fr>
date Thu, 18 Aug 2022 10:12:54 +0200
parents 95bc6b4ec753
children 71cd8447e3a4
line wrap: on
line source

/*
 * sciworkerd.h -- main sciworkerd file
 *
 * Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef SCIWORKERD_H
#define SCIWORKERD_H

/**
 * \file sciworkerd.h
 * \brief Main sciworkerd file.
 */

/**
 * \brief Maximum worker name.
 */
#define SCIWORKERD_NAME_MAX     64

/**
 * \brief Main sciworkerd configuration structure.
 */
extern struct sciworkerd {
	char name[SCIWORKERD_NAME_MAX]; /*!< This worker name to use. */
	unsigned int fetchinterval;     /*!< Delay in seconds before fetching jobs. */
	unsigned int maxjobs;           /*!< Maximum parallel jobs. */
	unsigned int timeout;           /*!< Maximum time in seconds before killing a job. */
} sciworkerd /*! Global variable. */;

/**
 * Initialize sciworkerd.
 */
void
sciworkerd_init(void);

/**
 * Run forever.
 */
void
sciworkerd_run(void);

/**
 * Cleanup sciworkerd resources and kill remaining tasks.
 */
void
sciworkerd_finish(void);

#endif /* !SCIWORKERD_H */