sched.h File Reference

Scheduler Routines (derived from cheops) More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_cb_names
Defines
#define	ast_sched_add_object(obj, con, when, callback)   ast_sched_add((con),(when),(callback), ASTOBJ_REF((obj)))
	Convenience macro for objects and reference (add)
#define	AST_SCHED_CB(a)   ((ast_sched_cb)(a))
#define	AST_SCHED_DEL(sched, id)
	Remove a scheduler entry.
#define	AST_SCHED_DEL_ACCESSOR(sched, obj, getter, setter)
#define	ast_sched_del_object(obj, destructor, con, id)
	Convenience macro for objects and reference (del)
#define	AST_SCHED_DEL_SPINLOCK(sched, id, lock)
	schedule task to get deleted releasing the lock between attempts
#define	AST_SCHED_DEL_UNREF(sched, id, refcall)
	schedule task to get deleted and call unref function
#define	AST_SCHED_REPLACE(id, sched, when, callback, data)   AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, 0)
#define	AST_SCHED_REPLACE_UNREF(id, sched, when, callback, data, unrefcall, addfailcall, refcall)   AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, 0, unrefcall, addfailcall, refcall)
#define	AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, variable)
#define	AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, variable, unrefcall, addfailcall, refcall)
Typedefs
typedef int(*	ast_sched_cb )(const void *data)
	scheduler callback
Functions
int	ast_sched_add (struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data) attribute_warn_unused_result
	Adds a scheduled event.
int	ast_sched_add_variable (struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data, int variable) attribute_warn_unused_result
	Adds a scheduled event with rescheduling support.
struct ast_sched_context *	ast_sched_context_create (void)
	Create a scheduler context.
void	ast_sched_context_destroy (struct ast_sched_context *c)
	destroys a schedule context
int	ast_sched_del (struct ast_sched_context *con, int id) attribute_warn_unused_result
	Deletes a scheduled event.
void	ast_sched_dump (struct ast_sched_context *con)
	Dumps the scheduler contents.
const void *	ast_sched_find_data (struct ast_sched_context *con, int id)
	Find a sched structure and return the data field associated with it.
int	ast_sched_replace (int old_id, struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data) attribute_warn_unused_result
	replace a scheduler entry
int	ast_sched_replace_variable (int old_id, struct ast_sched_context *con, int when, ast_sched_cb callback, const void *data, int variable) attribute_warn_unused_result
	replace a scheduler entry
void	ast_sched_report (struct ast_sched_context *con, struct ast_str **buf, struct ast_cb_names *cbnames)
	Show statics on what it is in the schedule queue.
int	ast_sched_runq (struct ast_sched_context *con)
	Runs the queue.
int	ast_sched_start_thread (struct ast_sched_context *con)
	Start a thread for processing scheduler entries.
int	ast_sched_wait (struct ast_sched_context *con) attribute_warn_unused_result
	Determines number of seconds until the next outstanding event to take place.
long	ast_sched_when (struct ast_sched_context *con, int id)
	Returns the number of seconds before an event takes place.

---

Detailed Description

Scheduler Routines (derived from cheops)

Definition in file sched.h.

---

Define Documentation

#define ast_sched_add_object	(		obj,
			con,
			when,
			callback
	)		ast_sched_add((con),(when),(callback), ASTOBJ_REF((obj)))

Convenience macro for objects and reference (add)

Definition at line 332 of file sched.h.

#define AST_SCHED_CB

(

a

)

((ast_sched_cb)(a))

Definition at line 171 of file sched.h.

#define AST_SCHED_DEL	(		sched,
			id
	)

Remove a scheduler entry.

This is a loop construct to ensure that the scheduled task get deleted. The idea is that if we loop attempting to remove the scheduled task, then whatever callback had been running will complete and reinsert the task into the scheduler.

Since macro expansion essentially works like pass-by-name parameter passing, this macro will still work correctly even if the id of the task to delete changes. This holds as long as the name of the id which could change is passed to the macro and not a copy of the value of the id.

Definition at line 46 of file sched.h.

Referenced by __oh323_destroy(), __oh323_update_info(), __sip_reliable_xmit(), __sip_semi_ack(), ack_trans(), ast_rtp_destroy(), ast_rtp_stop(), ast_sched_replace(), ast_sched_replace_variable(), build_gateway(), build_peer(), delete_users(), destroy_packet(), destroy_packets(), destroy_peer(), destroy_trans(), dialog_unlink_all(), dnsmgr_start_refresh(), do_reload(), esc_entry_destructor(), handle_command_response(), handle_request_cancel(), handle_sip_publish_remove(), iax2_destroy_helper(), iax2_frame_free(), iax2_poke_peer(), make_trunk(), mgcpsock_read(), misdn_tasks_remove(), qualify_peer(), realtime_peer(), receive_digit(), reg_source_db(), schedule_delivery(), sip_cc_agent_stop_offer_timer(), sip_cc_monitor_cancel_available_timer(), sip_registry_destroy(), sip_send_all_mwi_subscriptions(), sip_subscribe_mwi_destroy(), socket_process_helper(), submit_unscheduled_batch(), unlink_peer(), and update_registry().

#define AST_SCHED_DEL_ACCESSOR	(		sched,
			obj,
			getter,
			setter
	)

Definition at line 59 of file sched.h.

Referenced by filestream_close().

#define ast_sched_del_object	(		obj,
			destructor,
			con,
			id
	)

Convenience macro for objects and reference (del)

Definition at line 338 of file sched.h.

#define AST_SCHED_DEL_SPINLOCK	(		sched,
			id,
			lock
	)

schedule task to get deleted releasing the lock between attempts

Since:

1.6.1

Definition at line 94 of file sched.h.

Referenced by iax2_destroy_helper().

#define AST_SCHED_DEL_UNREF	(		sched,
			id,
			refcall
	)

schedule task to get deleted and call unref function

See also:

AST_SCHED_DEL

Since:

1.6.1

Definition at line 77 of file sched.h.

Referenced by ast_rtp_stop(), build_peer(), cleanup_all_regs(), dialog_unlink_all(), handle_request_invite(), handle_response_invite(), handle_response_register(), interpret_t38_parameters(), parse_register_contact(), peer_sched_cleanup(), restart_session_timer(), send_response(), sip_cancel_destroy(), sip_hangup(), sip_poke_peer(), sip_unregister(), start_session_timer(), stop_session_timer(), and update_provisional_keepalive().

#define AST_SCHED_REPLACE	(		id,
			sched,
			when,
			callback,
			data
	)		AST_SCHED_REPLACE_VARIABLE(id, sched, when, callback, data, 0)

Definition at line 121 of file sched.h.

Referenced by schedule_calendar_event().

#define AST_SCHED_REPLACE_UNREF	(		id,
			sched,
			when,
			callback,
			data,
			unrefcall,
			addfailcall,
			refcall
	)		AST_SCHED_REPLACE_VARIABLE_UNREF(id, sched, when, callback, data, 0, unrefcall, addfailcall, refcall)

Definition at line 145 of file sched.h.

Referenced by handle_response_peerpoke(), handle_response_register(), handle_sip_publish_modify(), handle_sip_publish_refresh(), realtime_peer(), reg_source_db(), sip_call(), sip_keepalive_all_peers(), sip_poke_all_peers(), sip_poke_noanswer(), sip_poke_peer(), sip_send_all_registers(), sip_send_keepalive(), and transmit_register().

#define AST_SCHED_REPLACE_VARIABLE	(		id,
			sched,
			when,
			callback,
			data,
			variable
	)

Definition at line 110 of file sched.h.

Referenced by __sip_reliable_xmit().

#define AST_SCHED_REPLACE_VARIABLE_UNREF	(		id,
			sched,
			when,
			callback,
			data,
			variable,
			unrefcall,
			addfailcall,
			refcall
	)

Note:

Not currently used in the source?

Since:

1.6.1

Definition at line 128 of file sched.h.

---

Typedef Documentation

typedef int(* ast_sched_cb)(const void *data)

scheduler callback

A scheduler callback takes a pointer with callback data and

Return values:

0	if the callback should not be rescheduled
non-zero	if the callback should be scheduled agai

Definition at line 170 of file sched.h.

---

Function Documentation

int ast_sched_add	(	struct ast_sched_context *	con,
		int	when,
		ast_sched_cb	callback,
		const void *	data
	)

Adds a scheduled event.

Schedule an event to take place at some point in the future. callback will be called with data as the argument, when milliseconds into the future (approximately)

If callback returns 0, no further events will be re-scheduled

Parameters:

con	Scheduler context to add
when	how many milliseconds to wait for event to occur
callback	function to call when the amount of time expires
data	data to pass to the callback

Returns:

Returns a schedule item ID on success, -1 on failure

Definition at line 417 of file sched.c.

References ast_sched_add_variable().

Referenced by __oh323_update_info(), ast_readaudio_callback(), ast_readvideo_callback(), ast_rtp_raw_write(), ast_rtp_read(), ast_sched_replace(), build_peer(), cc_generic_agent_start_offer_timer(), cc_generic_monitor_request_cc(), create_esc_entry(), do_register(), do_reload(), dtls_srtp_setup(), dundi_discover(), dundi_query(), dundi_send(), handle_command_response(), handle_request_invite(), handle_response_invite(), handle_response_subscribe(), iax2_hangup(), iax2_key_rotate(), iax2_sched_add(), mgcp_postrequest(), network_change_event_cb(), parse_register_contact(), populate_addr(), precache_trans(), qualify_peer(), receive_digit(), rtp_red_init(), sip_cc_agent_start_offer_timer(), sip_cc_monitor_request_cc(), sip_hangup(), sip_scheddestroy(), sip_send_all_mwi_subscriptions(), skinny_sched_add(), start_session_timer(), submit_scheduled_batch(), submit_unscheduled_batch(), transmit_register(), and update_provisional_keepalive().

{
   return ast_sched_add_variable(con, when, callback, data, 0);
}

int ast_sched_add_variable	(	struct ast_sched_context *	con,
		int	when,
		ast_sched_cb	callback,
		const void *	data,
		int	variable
	)

Adds a scheduled event with rescheduling support.

Parameters:

con	Scheduler context to add
when	how many milliseconds to wait for event to occur
callback	function to call when the amount of time expires
data	data to pass to the callback
variable	If true, the result value of callback function will be used for rescheduling

Schedule an event to take place at some point in the future. Callback will be called with data as the argument, when milliseconds into the future (approximately)

If callback returns 0, no further events will be re-scheduled

Returns:

Returns a schedule item ID on success, -1 on failure

Definition at line 374 of file sched.c.

References ast_cond_signal, ast_debug, ast_mutex_lock, ast_mutex_unlock, ast_sched_dump(), ast_tv(), sched::callback, sched_thread::cond, sched::data, DEBUG, ast_sched_context::eventcnt, sched::id, ast_sched_context::lock, option_debug, sched::resched, sched_alloc(), sched_release(), sched_settime(), ast_sched_context::sched_thread, schedule(), sched::variable, and sched::when.

Referenced by _misdn_tasks_add_variable(), ast_sched_add(), ast_sched_replace_variable(), dnsmgr_start_refresh(), do_reload(), and stun_start_monitor().

{
   struct sched *tmp;
   int res = -1;

   DEBUG(ast_debug(1, "ast_sched_add()\n"));

   ast_mutex_lock(&con->lock);
   if ((tmp = sched_alloc(con))) {
      tmp->id = con->eventcnt++;
      tmp->callback = callback;
      tmp->data = data;
      tmp->resched = when;
      tmp->variable = variable;
      tmp->when = ast_tv(0, 0);
      if (sched_settime(&tmp->when, when)) {
         sched_release(con, tmp);
      } else {
         schedule(con, tmp);
         res = tmp->id;
      }
   }
#ifdef DUMP_SCHEDULER
   /* Dump contents of the context while we have the lock so nothing gets screwed up by accident. */
   if (option_debug)
      ast_sched_dump(con);
#endif
   if (con->sched_thread) {
      ast_cond_signal(&con->sched_thread->cond);
   }
   ast_mutex_unlock(&con->lock);

   return res;
}

struct ast_sched_context* ast_sched_context_create

(

void

)

[read]

Create a scheduler context.

Returns:

Returns a malloc'd sched_context structure, NULL on failure

Definition at line 210 of file sched.c.

References sched::__heap_index, ast_calloc, ast_hashtab_create(), ast_hashtab_newsize_java(), ast_hashtab_resize_java(), ast_heap_create(), ast_mutex_init, ast_sched_context_destroy(), ast_sched_context::eventcnt, ast_sched_context::lock, sched_cmp(), sched_hash(), ast_sched_context::sched_heap, sched_time_cmp(), and ast_sched_context::schedq_ht.

Referenced by __ast_channel_alloc_ap(), ast_cc_init(), ast_cdr_engine_init(), dnsmgr_init(), load_module(), misdn_tasks_init(), and stun_start_monitor().

{
   struct ast_sched_context *tmp;

   if (!(tmp = ast_calloc(1, sizeof(*tmp)))) {
      return NULL;
   }

   ast_mutex_init(&tmp->lock);
   tmp->eventcnt = 1;

   tmp->schedq_ht = ast_hashtab_create(23, sched_cmp, ast_hashtab_resize_java, ast_hashtab_newsize_java, sched_hash, 1);

   if (!(tmp->sched_heap = ast_heap_create(8, sched_time_cmp,
         offsetof(struct sched, __heap_index)))) {
      ast_sched_context_destroy(tmp);
      return NULL;
   }

   return tmp;
}

void ast_sched_context_destroy

(

struct ast_sched_context *

c

)

destroys a schedule context

Parameters:

c	Context to free

Definition at line 232 of file sched.c.

References ast_free, ast_hashtab_destroy(), ast_heap_destroy(), ast_heap_pop(), AST_LIST_REMOVE_HEAD, ast_mutex_destroy, ast_mutex_lock, ast_mutex_unlock, sched::list, ast_sched_context::lock, ast_sched_context::sched_heap, ast_sched_context::sched_thread, sched_thread_destroy(), ast_sched_context::schedc, and ast_sched_context::schedq_ht.

Referenced by __unload_module(), ast_channel_destructor(), ast_hangup(), ast_sched_context_create(), cc_shutdown(), cdr_engine_shutdown(), dnsmgr_shutdown(), load_module(), misdn_tasks_destroy(), stun_start_monitor(), stun_stop_monitor(), and unload_module().

{
   struct sched *s;

   sched_thread_destroy(con);
   con->sched_thread = NULL;

   ast_mutex_lock(&con->lock);

#ifdef SCHED_MAX_CACHE
   while ((s = AST_LIST_REMOVE_HEAD(&con->schedc, list))) {
      ast_free(s);
   }
#endif

   if (con->sched_heap) {
      while ((s = ast_heap_pop(con->sched_heap))) {
         ast_free(s);
      }
      ast_heap_destroy(con->sched_heap);
      con->sched_heap = NULL;
   }

   ast_hashtab_destroy(con->schedq_ht, NULL);
   con->schedq_ht = NULL;

   ast_mutex_unlock(&con->lock);
   ast_mutex_destroy(&con->lock);

   ast_free(con);
}

int ast_sched_del	(	struct ast_sched_context *	con,
		int	id
	)

Deletes a scheduled event.

Remove this event from being run. A procedure should not remove its own event, but return 0 instead. In most cases, you should not call this routine directly, but use the AST_SCHED_DEL() macro instead (especially if you don't intend to do something different when it returns failure).

Parameters:

con	scheduling context to delete item from
id	ID of the scheduled item to delete

Returns:

Returns 0 on success, -1 on failure

Definition at line 439 of file sched.c.

References ast_assert, ast_cond_signal, ast_debug, ast_hashtab_lookup(), ast_hashtab_remove_this_object(), ast_heap_remove(), ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_sched_dump(), ast_threadstorage_get(), sched_thread::cond, DEBUG, sched::id, last_del_id, ast_sched_context::lock, LOG_WARNING, option_debug, ast_sched_context::sched_heap, sched_release(), ast_sched_context::sched_thread, ast_sched_context::schedcnt, and ast_sched_context::schedq_ht.

Referenced by __sip_ack(), ast_rtp_prop_set(), ast_rtp_stop(), cc_generic_agent_stop_offer_timer(), cc_generic_monitor_cancel_available_timer(), destroy_event(), and skinny_sched_del().

{
   struct sched *s, tmp = {
      .id = id,
   };
   int *last_id = ast_threadstorage_get(&last_del_id, sizeof(int));

   DEBUG(ast_debug(1, "ast_sched_del(%d)\n", id));

   if (id < 0) {
      return 0;
   }

   ast_mutex_lock(&con->lock);
   s = ast_hashtab_lookup(con->schedq_ht, &tmp);
   if (s) {
      if (!ast_heap_remove(con->sched_heap, s)) {
         ast_log(LOG_WARNING,"sched entry %d not in the sched heap?\n", s->id);
      }

      if (!ast_hashtab_remove_this_object(con->schedq_ht, s)) {
         ast_log(LOG_WARNING,"Found sched entry %d, then couldn't remove it?\n", s->id);
      }

      con->schedcnt--;

      sched_release(con, s);
   }

#ifdef DUMP_SCHEDULER
   /* Dump contents of the context while we have the lock so nothing gets screwed up by accident. */
   if (option_debug)
      ast_sched_dump(con);
#endif
   if (con->sched_thread) {
      ast_cond_signal(&con->sched_thread->cond);
   }
   ast_mutex_unlock(&con->lock);

   if (!s && *last_id != id) {
      ast_debug(1, "Attempted to delete nonexistent schedule entry %d!\n", id);
#ifndef AST_DEVMODE
      ast_assert(s != NULL);
#else
      {
      char buf[100];
      snprintf(buf, sizeof(buf), "s != NULL, id=%d", id);
      _ast_assert(0, buf, file, line, function);
      }
#endif
      *last_id = id;
      return -1;
   } else if (!s) {
      return -1;
   }

   return 0;
}

void ast_sched_dump

(

struct ast_sched_context *

con

)

Dumps the scheduler contents.

Debugging: Dump the contents of the scheduler to stderr

Parameters:

con	Context to dump

Definition at line 539 of file sched.c.

References ast_debug, ast_heap_peek(), ast_heap_size(), ast_mutex_lock, ast_mutex_unlock, ast_tvnow(), ast_tvsub(), ast_sched_context::eventcnt, ast_sched_context::highwater, ast_sched_context::lock, ast_sched_context::sched_heap, ast_sched_context::schedccnt, and ast_sched_context::schedcnt.

Referenced by ast_sched_add_variable(), ast_sched_del(), handle_dump_sched(), sip_do_reload(), and unload_module().

{
   struct sched *q;
   struct timeval when = ast_tvnow();
   int x;
   size_t heap_size;
#ifdef SCHED_MAX_CACHE
   ast_debug(1, "Asterisk Schedule Dump (%d in Q, %d Total, %d Cache, %d high-water)\n", con->schedcnt, con->eventcnt - 1, con->schedccnt, con->highwater);
#else
   ast_debug(1, "Asterisk Schedule Dump (%d in Q, %d Total, %d high-water)\n", con->schedcnt, con->eventcnt - 1, con->highwater);
#endif

   ast_debug(1, "=============================================================\n");
   ast_debug(1, "|ID    Callback          Data              Time  (sec:ms)   |\n");
   ast_debug(1, "+-----+-----------------+-----------------+-----------------+\n");
   ast_mutex_lock(&con->lock);
   heap_size = ast_heap_size(con->sched_heap);
   for (x = 1; x <= heap_size; x++) {
      struct timeval delta;
      q = ast_heap_peek(con->sched_heap, x);
      delta = ast_tvsub(q->when, when);
      ast_debug(1, "|%.4d | %-15p | %-15p | %.6ld : %.6ld |\n",
         q->id,
         q->callback,
         q->data,
         (long)delta.tv_sec,
         (long int)delta.tv_usec);
   }
   ast_mutex_unlock(&con->lock);
   ast_debug(1, "=============================================================\n");
}

const void* ast_sched_find_data	(	struct ast_sched_context *	con,
		int	id
	)

Find a sched structure and return the data field associated with it.

Parameters:

con	scheduling context in which to search fro the matching id
id	ID of the scheduled item to find

Returns:

the data field from the matching sched struct if found; else return NULL if not found.

Since:

1.6.1

Definition at line 422 of file sched.c.

References ast_hashtab_lookup(), sched::data, sched::id, and ast_sched_context::schedq_ht.

{
   struct sched tmp,*res;
   tmp.id = id;
   res = ast_hashtab_lookup(con->schedq_ht, &tmp);
   if (res)
      return res->data;
   return NULL;
}

int ast_sched_replace	(	int	old_id,
		struct ast_sched_context *	con,
		int	when,
		ast_sched_cb	callback,
		const void *	data
	)

replace a scheduler entry

Deprecated:

You should use the AST_SCHED_REPLACE() macro instead.

This deletes the scheduler entry for old_id if it exists, and then calls ast_sched_add to create a new entry. A negative old_id will be ignored.

Return values:

-1	failure
otherwise,returns	scheduled item ID

Definition at line 409 of file sched.c.

References ast_sched_add(), and AST_SCHED_DEL.

Referenced by iax2_sched_replace().

{
   if (old_id > -1) {
      AST_SCHED_DEL(con, old_id);
   }
   return ast_sched_add(con, when, callback, data);
}

int ast_sched_replace_variable	(	int	old_id,
		struct ast_sched_context *	con,
		int	when,
		ast_sched_cb	callback,
		const void *	data,
		int	variable
	)

replace a scheduler entry

Deprecated:

You should use the AST_SCHED_REPLACE_VARIABLE() macro instead.

This deletes the scheduler entry for old_id if it exists, and then calls ast_sched_add to create a new entry. A negative old_id will be ignored.

Return values:

-1	failure
otherwise,returns	scheduled item ID

Definition at line 362 of file sched.c.

References ast_sched_add_variable(), and AST_SCHED_DEL.

{
   /* 0 means the schedule item is new; do not delete */
   if (old_id > 0) {
      AST_SCHED_DEL(con, old_id);
   }
   return ast_sched_add_variable(con, when, callback, data, variable);
}

void ast_sched_report	(	struct ast_sched_context *	con,
		struct ast_str **	buf,
		struct ast_cb_names *	cbnames
	)

Show statics on what it is in the schedule queue.

Parameters:

con	Schedule context to check
buf	dynamic string to store report
cbnames	to check against

Since:

1.6.1

Definition at line 501 of file sched.c.

References ast_heap_peek(), ast_heap_size(), ast_mutex_lock, ast_mutex_unlock, ast_str_append(), ast_str_set(), sched::callback, ast_cb_names::cblist, ast_sched_context::highwater, ast_cb_names::list, ast_sched_context::lock, ast_cb_names::numassocs, ast_sched_context::sched_heap, and ast_sched_context::schedcnt.

Referenced by sip_show_sched().

{
   int i, x;
   struct sched *cur;
   int countlist[cbnames->numassocs + 1];
   size_t heap_size;

   memset(countlist, 0, sizeof(countlist));
   ast_str_set(buf, 0, " Highwater = %d\n schedcnt = %d\n", con->highwater, con->schedcnt);

   ast_mutex_lock(&con->lock);

   heap_size = ast_heap_size(con->sched_heap);
   for (x = 1; x <= heap_size; x++) {
      cur = ast_heap_peek(con->sched_heap, x);
      /* match the callback to the cblist */
      for (i = 0; i < cbnames->numassocs; i++) {
         if (cur->callback == cbnames->cblist[i]) {
            break;
         }
      }
      if (i < cbnames->numassocs) {
         countlist[i]++;
      } else {
         countlist[cbnames->numassocs]++;
      }
   }

   ast_mutex_unlock(&con->lock);

   for (i = 0; i < cbnames->numassocs; i++) {
      ast_str_append(buf, 0, "    %s : %d\n", cbnames->list[i], countlist[i]);
   }

   ast_str_append(buf, 0, "   <unknown> : %d\n", countlist[cbnames->numassocs]);
}

int ast_sched_runq

(

struct ast_sched_context *

con

)

Runs the queue.

Run the queue, executing all callbacks which need to be performed at this time.

Parameters:

con	Scheduling context to run
con	context to act upon

Returns:

Returns the number of events processed.

Definition at line 574 of file sched.c.

References ast_debug, ast_hashtab_remove_this_object(), ast_heap_peek(), ast_heap_pop(), ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_tv(), ast_tvadd(), ast_tvcmp(), ast_tvnow(), sched::callback, sched::data, DEBUG, sched::id, ast_sched_context::lock, LOG_ERROR, sched::resched, ast_sched_context::sched_heap, sched_release(), sched_settime(), ast_sched_context::schedcnt, ast_sched_context::schedq_ht, schedule(), sched::variable, and sched::when.

Referenced by background_detect_exec(), dial_exec_full(), do_cdr(), do_monitor(), do_refresh(), handle_speechrecognize(), misdn_tasks_thread_func(), network_thread(), reload_config(), sched_run(), speech_background(), wait_for_winner(), and waitstream_core().

{
   struct sched *current;
   struct timeval when;
   int numevents;
   int res;

   DEBUG(ast_debug(1, "ast_sched_runq()\n"));

   ast_mutex_lock(&con->lock);

   when = ast_tvadd(ast_tvnow(), ast_tv(0, 1000));
   for (numevents = 0; (current = ast_heap_peek(con->sched_heap, 1)); numevents++) {
      /* schedule all events which are going to expire within 1ms.
       * We only care about millisecond accuracy anyway, so this will
       * help us get more than one event at one time if they are very
       * close together.
       */
      if (ast_tvcmp(current->when, when) != -1) {
         break;
      }

      current = ast_heap_pop(con->sched_heap);

      if (!ast_hashtab_remove_this_object(con->schedq_ht, current)) {
         ast_log(LOG_ERROR,"Sched entry %d was in the schedq list but not in the hashtab???\n", current->id);
      }

      con->schedcnt--;

      /*
       * At this point, the schedule queue is still intact.  We
       * have removed the first event and the rest is still there,
       * so it's permissible for the callback to add new events, but
       * trying to delete itself won't work because it isn't in
       * the schedule queue.  If that's what it wants to do, it
       * should return 0.
       */

      ast_mutex_unlock(&con->lock);
      res = current->callback(current->data);
      ast_mutex_lock(&con->lock);

      if (res) {
         /*
          * If they return non-zero, we should schedule them to be
          * run again.
          */
         if (sched_settime(&current->when, current->variable? res : current->resched)) {
            sched_release(con, current);
         } else {
            schedule(con, current);
         }
      } else {
         /* No longer needed, so release it */
         sched_release(con, current);
      }
   }

   ast_mutex_unlock(&con->lock);

   return numevents;
}

int ast_sched_start_thread

(

struct ast_sched_context *

con

)

Start a thread for processing scheduler entries.

Parameters:

con	the scheduler context this thread will manage

Return values:

0	success
non-zero	failure

Definition at line 163 of file sched.c.

References ast_calloc, ast_cond_init, ast_log(), ast_pthread_create_background, AST_PTHREADT_NULL, sched_thread::cond, LOG_ERROR, sched_run(), ast_sched_context::sched_thread, sched_thread_destroy(), and sched_thread::thread.

Referenced by ast_cc_init(), load_module(), and stun_start_monitor().

{
   struct sched_thread *st;

   if (con->sched_thread) {
      ast_log(LOG_ERROR, "Thread already started on this scheduler context\n");
      return -1;
   }

   if (!(st = ast_calloc(1, sizeof(*st)))) {
      return -1;
   }

   ast_cond_init(&st->cond, NULL);

   st->thread = AST_PTHREADT_NULL;

   con->sched_thread = st;

   if (ast_pthread_create_background(&st->thread, NULL, sched_run, con)) {
      ast_log(LOG_ERROR, "Failed to create scheduler thread\n");
      sched_thread_destroy(con);
      return -1;
   }

   return 0;
}

int ast_sched_wait

(

struct ast_sched_context *

con

)

Determines number of seconds until the next outstanding event to take place.

Determine the number of seconds until the next outstanding event should take place, and return the number of milliseconds until it needs to be run. This value is perfect for passing to the poll call.

Parameters:

con	context to act upon

Returns:

Returns "-1" if there is nothing there are no scheduled events (and thus the poll should not timeout)

Definition at line 302 of file sched.c.

References ast_debug, ast_heap_peek(), ast_mutex_lock, ast_mutex_unlock, ast_tvdiff_ms(), ast_tvnow(), DEBUG, ast_sched_context::lock, ast_sched_context::sched_heap, and sched::when.

Referenced by background_detect_exec(), dial_exec_full(), do_cdr(), do_monitor(), do_refresh(), handle_speechrecognize(), misdn_tasks_thread_func(), network_thread(), sched_run(), speech_background(), wait_for_winner(), and waitstream_core().

{
   int ms;
   struct sched *s;

   DEBUG(ast_debug(1, "ast_sched_wait()\n"));

   ast_mutex_lock(&con->lock);
   if ((s = ast_heap_peek(con->sched_heap, 1))) {
      ms = ast_tvdiff_ms(s->when, ast_tvnow());
      if (ms < 0) {
         ms = 0;
      }
   } else {
      ms = -1;
   }
   ast_mutex_unlock(&con->lock);

   return ms;
}

long ast_sched_when	(	struct ast_sched_context *	con,
		int	id
	)

Returns the number of seconds before an event takes place.

Parameters:

con	Context to use
id	Id to dump

Definition at line 638 of file sched.c.

References ast_debug, ast_hashtab_lookup(), ast_mutex_lock, ast_mutex_unlock, ast_tvnow(), DEBUG, sched::id, ast_sched_context::lock, ast_sched_context::schedq_ht, and sched::when.

Referenced by _sip_show_peer(), handle_cli_status(), and parse_register_contact().

{
   struct sched *s, tmp;
   long secs = -1;
   DEBUG(ast_debug(1, "ast_sched_when()\n"));

   ast_mutex_lock(&con->lock);

   /* these next 2 lines replace a lookup loop */
   tmp.id = id;
   s = ast_hashtab_lookup(con->schedq_ht, &tmp);

   if (s) {
      struct timeval now = ast_tvnow();
      secs = s->when.tv_sec - now.tv_sec;
   }
   ast_mutex_unlock(&con->lock);

   return secs;
}