/*
This file is part of GNUnet
- (C) 2009-2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009-2016 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_scheduler_lib.h
- * @brief API to schedule computations using continuation passing style
* @author Christian Grothoff
- * @defgroup scheduler Event loop (scheduler)
+ *
+ * @file
+ * API to schedule computations using continuation passing style
+ *
+ * @defgroup scheduler Scheduler library
+ * Event loop (scheduler)
+ *
+ * Schedule computations using continuation passing style.
+ *
* @{
*/
/**
* Opaque reference to a task.
*/
-typedef unsigned long long GNUNET_SCHEDULER_TaskIdentifier;
-
-
-/**
- * Constant used to indicate that the scheduled
- * task has no others as prerequisites.
- */
-#define GNUNET_SCHEDULER_NO_TASK ((GNUNET_SCHEDULER_TaskIdentifier) 0)
+struct GNUNET_SCHEDULER_Task;
/**
* Reasons why the schedule may have triggered
*/
enum GNUNET_SCHEDULER_Reason
{
+ /**
+ * This task is not ready.
+ */
+ GNUNET_SCHEDULER_REASON_NONE = 0,
+
/**
* This is the very first task run during startup.
*/
- GNUNET_SCHEDULER_REASON_STARTUP = 0,
+ GNUNET_SCHEDULER_REASON_STARTUP = 1,
/**
- * We are shutting down and are running all shutdown-related tasks
- * (regardless of timeout, etc.).
+ * We are shutting down and are running all shutdown-related tasks.
*/
- GNUNET_SCHEDULER_REASON_SHUTDOWN = 1,
+ GNUNET_SCHEDULER_REASON_SHUTDOWN = 2,
/**
* The specified timeout has expired.
* (also set if the delay given was 0).
*/
- GNUNET_SCHEDULER_REASON_TIMEOUT = 2,
+ GNUNET_SCHEDULER_REASON_TIMEOUT = 4,
/**
* The reading socket is ready.
*/
- GNUNET_SCHEDULER_REASON_READ_READY = 4,
+ GNUNET_SCHEDULER_REASON_READ_READY = 8,
/**
* The writing socket is ready.
*/
- GNUNET_SCHEDULER_REASON_WRITE_READY = 8,
+ GNUNET_SCHEDULER_REASON_WRITE_READY = 16,
/**
* The prerequisite task is done.
*/
- GNUNET_SCHEDULER_REASON_PREREQ_DONE = 16
+ GNUNET_SCHEDULER_REASON_PREREQ_DONE = 32
};
-/**
- * Valid task priorities. Use these, do not
- * pass random integers!
- */
-enum GNUNET_SCHEDULER_Priority
-{
- /**
- * Run with the same priority as the current job.
- */
- GNUNET_SCHEDULER_PRIORITY_KEEP = 0,
-
- /**
- * Run when otherwise idle.
- */
- GNUNET_SCHEDULER_PRIORITY_IDLE = 1,
-
- /**
- * Run as background job (higher than idle,
- * lower than default).
- */
- GNUNET_SCHEDULER_PRIORITY_BACKGROUND = 2,
-
- /**
- * Run with the default priority (normal
- * P2P operations). Any task that is scheduled
- * without an explicit priority being specified
- * will run with this priority.
- */
- GNUNET_SCHEDULER_PRIORITY_DEFAULT = 3,
-
- /**
- * Run with high priority (important requests).
- * Higher than DEFAULT.
- */
- GNUNET_SCHEDULER_PRIORITY_HIGH = 4,
-
- /**
- * Run with priority for interactive tasks.
- * Higher than "HIGH".
- */
- GNUNET_SCHEDULER_PRIORITY_UI = 5,
-
- /**
- * Run with priority for urgent tasks. Use
- * for things like aborts and shutdowns that
- * need to preempt "UI"-level tasks.
- * Higher than "UI".
- */
- GNUNET_SCHEDULER_PRIORITY_URGENT = 6,
-
- /**
- * This is an internal priority level that is only used for tasks
- * that are being triggered due to shutdown (they have automatically
- * highest priority). User code must not use this priority level
- * directly. Tasks run with this priority level that internally
- * schedule other tasks will see their original priority level
- * be inherited (unless otherwise specified).
- */
- GNUNET_SCHEDULER_PRIORITY_SHUTDOWN = 7,
-
- /**
- * Number of priorities (must be the last priority).
- * This priority must not be used by clients.
- */
- GNUNET_SCHEDULER_PRIORITY_COUNT = 8
-};
-
#include "gnunet_time_lib.h"
#include "gnunet_network_lib.h"
* @param cls closure
* @param tc context information (why was this task triggered now)
*/
-typedef void (*GNUNET_SCHEDULER_Task) (void *cls,
- const struct GNUNET_SCHEDULER_TaskContext
- * tc);
+typedef void
+(*GNUNET_SCHEDULER_TaskCallback) (void *cls);
/**
* @param timeout relative value when to return
* @return number of selected sockets, #GNUNET_SYSERR on error
*/
-typedef int (*GNUNET_SCHEDULER_select) (void *cls,
- struct GNUNET_NETWORK_FDSet *rfds,
- struct GNUNET_NETWORK_FDSet *wfds,
- struct GNUNET_NETWORK_FDSet *efds,
- struct GNUNET_TIME_Relative timeout);
+typedef int
+(*GNUNET_SCHEDULER_select) (void *cls,
+ struct GNUNET_NETWORK_FDSet *rfds,
+ struct GNUNET_NETWORK_FDSet *wfds,
+ struct GNUNET_NETWORK_FDSet *efds,
+ struct GNUNET_TIME_Relative timeout);
/**
* tasks have completed. On systems with signals, receiving a SIGTERM
* (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown
* to be run after the active task is complete. As a result, SIGTERM
- * causes all active tasks to be scheduled with reason
+ * causes all shutdown tasks to be scheduled with reason
* #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
* afterwards will execute normally!). Note that any particular
* signal will only shut down one scheduler; applications should
* always only create a single scheduler.
*
* @param task task to run first (and immediately)
- * @param task_cls closure of task
+ * @param task_cls closure of @a task
*/
void
-GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_Task task, void *task_cls);
+GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
- * Request the shutdown of the scheduler. Marks all currently
- * pending tasks as ready because of shutdown. This will
- * cause all tasks to run (as soon as possible, respecting
- * priorities and prerequisite tasks). Note that tasks
- * scheduled AFTER this call may still be delayed arbitrarily.
+ * Request the shutdown of a scheduler. Marks all tasks
+ * awaiting shutdown as ready. Note that tasks
+ * scheduled with #GNUNET_SCHEDULER_add_shutdown() AFTER this call
+ * will be delayed until the next shutdown signal.
*/
void
GNUNET_SCHEDULER_shutdown (void);
/**
- * Obtain the reason code for why the current task was
- * started. Will return the same value as
- * the GNUNET_SCHEDULER_TaskContext's reason field.
+ * Obtain the reasoning why the current task was
+ * started.
*
- * @return reason(s) why the current task is run
+ * @return task context with information why the current task is run
*/
-enum GNUNET_SCHEDULER_Reason
-GNUNET_SCHEDULER_get_reason (void);
+const struct GNUNET_SCHEDULER_TaskContext *
+GNUNET_SCHEDULER_get_task_context (void);
/**
* @return the closure of the callback of the cancelled task
*/
void *
-GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task);
-
-
-/**
- * Continue the current execution with the given function. This is
- * similar to the other "add" functions except that there is no delay
- * and the reason code can be specified.
- *
- * @param task main function of the task
- * @param task_cls closure of task
- * @param reason reason for task invocation
- */
-void
-GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task, void *task_cls,
- enum GNUNET_SCHEDULER_Reason reason);
+GNUNET_SCHEDULER_cancel (struct GNUNET_SCHEDULER_Task *task);
/**
* @param priority priority to use for the task
*/
void
-GNUNET_SCHEDULER_add_continuation_with_priority (GNUNET_SCHEDULER_Task task, void *task_cls,
- enum GNUNET_SCHEDULER_Reason reason,
- enum GNUNET_SCHEDULER_Priority priority);
+GNUNET_SCHEDULER_add_with_reason_and_priority (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls,
+ enum GNUNET_SCHEDULER_Reason reason,
+ enum GNUNET_SCHEDULER_Priority priority);
/**
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_with_priority (enum GNUNET_SCHEDULER_Priority prio,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
-GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_Task task, void *task_cls);
+struct GNUNET_SCHEDULER_Task *
+GNUNET_SCHEDULER_add_now (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
+
+
+/**
+ * Schedule a new task to be run on shutdown, that is when a CTRL-C
+ * signal is received, or when #GNUNET_SCHEDULER_shutdown() is being
+ * invoked.
+ *
+ * @param task main function of the task
+ * @param task_cls closure of @a task
+ * @return unique task identifier for the job
+ * only valid until @a task is started!
+ */
+struct GNUNET_SCHEDULER_Task *
+GNUNET_SCHEDULER_add_shutdown (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
- GNUNET_SCHEDULER_Task task,
+ GNUNET_SCHEDULER_TaskCallback task,
void *task_cls);
* will be scheduled for execution once the delay has expired. It
* will be run with the DEFAULT priority.
*
- * * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * @param delay when should this operation time out?
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_delayed (struct GNUNET_TIME_Relative delay,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* Schedule a new task to be run with a specified delay. The task
* will be scheduled for execution once the delay has expired.
*
- * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * @param delay when should this operation time out?
* @param priority priority to use for the task
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_delayed_with_priority (struct GNUNET_TIME_Relative delay,
enum GNUNET_SCHEDULER_Priority priority,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* scheduled for execution once either the delay has expired or the
* socket operation is ready. It will be run with the DEFAULT priority.
*
- * * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * * @param delay when should this operation time out?
* @param rfd read file-descriptor
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_read_net (struct GNUNET_TIME_Relative delay,
struct GNUNET_NETWORK_Handle *rfd,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* either the delay has expired or the socket operation is ready. It
* will be run with the DEFAULT priority.
*
- * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * @param delay when should this operation time out?
* @param priority priority to use for the task
* @param rfd read file-descriptor
* @param task main function of the task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_read_net_with_priority (struct GNUNET_TIME_Relative delay,
enum GNUNET_SCHEDULER_Priority priority,
struct GNUNET_NETWORK_Handle *rfd,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* scheduled for execution once either the delay has expired or the
* socket operation is ready. It will be run with the DEFAULT priority.
*
- * * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * * @param delay when should this operation time out?
* @param wfd write file-descriptor
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_write_net (struct GNUNET_TIME_Relative delay,
struct GNUNET_NETWORK_Handle *wfd,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* scheduled for execution once either the delay has expired or the
* socket operation is ready.
*
- * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * @param delay when should this operation time out?
* @param priority priority of the task
* @param fd file-descriptor
* @param on_read whether to poll the file-descriptor for readability
* @return unique task identifier for the job
* only valid until "task" is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_net_with_priority (struct GNUNET_TIME_Relative delay,
enum GNUNET_SCHEDULER_Priority priority,
struct GNUNET_NETWORK_Handle *fd,
- int on_read, int on_write,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ int on_read,
+ int on_write,
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* Schedule a new task to be run with a specified delay or when the
* scheduled for execution once either the delay has expired or the
* socket operation is ready. It will be run with the DEFAULT priority.
*
- * * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * * @param delay when should this operation time out?
* @param rfd read file-descriptor
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until "task" is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_read_file (struct GNUNET_TIME_Relative delay,
const struct GNUNET_DISK_FileHandle *rfd,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* scheduled for execution once either the delay has expired or the
* socket operation is ready. It will be run with the DEFAULT priority.
*
- * * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * * @param delay when should this operation time out?
* @param wfd write file-descriptor
* @param task main function of the task
* @param task_cls closure of @a task
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_write_file (struct GNUNET_TIME_Relative delay,
const struct GNUNET_DISK_FileHandle *wfd,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* scheduled for execution once either the delay has expired or the
* socket operation is ready.
*
- * @param delay when should this operation time out? Use
- * #GNUNET_TIME_UNIT_FOREVER_REL for "on shutdown"
+ * @param delay when should this operation time out?
* @param priority priority of the task
* @param fd file-descriptor
* @param on_read whether to poll the file-descriptor for readability
* @return unique task identifier for the job
* only valid until @a task is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_file_with_priority (struct GNUNET_TIME_Relative delay,
enum GNUNET_SCHEDULER_Priority priority,
const struct GNUNET_DISK_FileHandle *fd,
int on_read, int on_write,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* (prerequisite-run)
* && (delay-ready
* || any-rs-ready
- * || any-ws-ready
- * || shutdown-active)
+ * || any-ws-ready)
* </code>
*
* @param prio how important is this task?
- * @param delay how long should we wait? Use #GNUNET_TIME_UNIT_FOREVER_REL for "forever",
- * which means that the task will only be run after we receive SIGTERM
+ * @param delay how long should we wait?
* @param rs set of file descriptors we want to read (can be NULL)
* @param ws set of file descriptors we want to write (can be NULL)
* @param task main function of the task
* @return unique task identifier for the job
* only valid until "task" is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
+struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
struct GNUNET_TIME_Relative delay,
const struct GNUNET_NETWORK_FDSet *rs,
const struct GNUNET_NETWORK_FDSet *ws,
- GNUNET_SCHEDULER_Task task, void *task_cls);
+ GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls);
/**
* Sets the select function to use in the scheduler (scheduler_select).
void *new_select_cls);
-/** @} */ /* end of group scheduler */
-
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#endif
#endif
+
+/** @} */ /* end of group scheduler */
projects / oweals / gnunet.git / blobdiff