/*
This file is part of GNUnet
- (C) 2009-2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
/**
* 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.).
*/
- 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
};
* @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,
+ const struct GNUNET_SCHEDULER_TaskContext *tc);
/**
* @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);
/**
* @param task_cls closure of 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 a scheduler. Marks all currently
+ * 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
* @return the closure of the callback of the cancelled task
*/
void *
-GNUNET_SCHEDULER_cancel (GNUNET_SCHEDULER_TaskIdentifier task);
+GNUNET_SCHEDULER_cancel (struct GNUNET_SCHEDULER_Task *task);
/**
* @param reason reason for task invocation
*/
void
-GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_Task task, void *task_cls,
+GNUNET_SCHEDULER_add_continuation (GNUNET_SCHEDULER_TaskCallback task,
+ void *task_cls,
enum GNUNET_SCHEDULER_Reason reason);
* @param priority priority to use for the task
*/
void
-GNUNET_SCHEDULER_add_continuation_with_priority (GNUNET_SCHEDULER_Task task, void *task_cls,
+GNUNET_SCHEDULER_add_continuation_with_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);
/**
- * Schedule a new task to be run as soon as possible. The task
- * will be run with the DEFAULT priority.
+ * Schedule a new task to be run as soon as possible. Note that this
+ * does not guarantee that this will be the next task that is being
+ * run, as other tasks with higher priority (or that are already ready
+ * to run) might get to run first. Just as with delays, clients must
+ * not rely on any particular order of execution between tasks
+ * scheduled concurrently.
+ *
+ * The task will be run with the DEFAULT priority.
*
* @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
-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);
/**
* @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);
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
+/**
+ * Schedule a new task to be run with a specified delay or when the
+ * specified file descriptor is ready. The delay can be
+ * used as a timeout on the socket being ready. The task will be
+ * 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 priority priority of the task
+ * @param fd file-descriptor
+ * @param on_read whether to poll the file-descriptor for readability
+ * @param on_write whether to poll the file-descriptor for writability
+ * @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!
+ */
+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_TaskCallback task,
+ void *task_cls);
+
/**
* Schedule a new task to be run with a specified delay or when the
* specified file descriptor is ready for reading. The delay can be
* @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);
/**
* @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);
+
+
+/**
+ * Schedule a new task to be run with a specified delay or when the
+ * specified file descriptor is ready. The delay can be
+ * used as a timeout on the socket being ready. The task will be
+ * 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 priority priority of the task
+ * @param fd file-descriptor
+ * @param on_read whether to poll the file-descriptor for readability
+ * @param on_write whether to poll the file-descriptor for writability
+ * @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_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_TaskCallback task,
+ void *task_cls);
/**
* @return unique task identifier for the job
* only valid until "task" is started!
*/
-GNUNET_SCHEDULER_TaskIdentifier
-GNUNET_SCHEDULER_add_select (enum GNUNET_SCHEDULER_Priority prio,
+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).
projects / oweals / gnunet.git / blobdiff