ec_mailq_dequeue_live_message

March 26, 2020 Contributors

Name

ec_mailq_dequeue_live_message — Removes a message from the mail queues and returns it if found

Synopsis

#include "mail_queue.h"

| ec_message * **ec_mailq_dequeue_live_message** ( | mid); |   |

message_id * <var class="pdparam">mid</var>;

Description

Removes a message from the mail queues and returns it if found.

Note

When this function returns an ec_message, it must take responsibility for that message.

Parameters

mid

A message ID. For a definition of this data structure see “message_id”.

Return Values

This function returns an ec_message struct. For a definition of this data structure see “ec_message”.

Threading

It is legal to call this function in the Scheduler thread.

See Also

ec_mailq_insert_active, ec_mailq_message_requeue and ec_mailq_find_live_message