ec_async_fail

March 26, 2020 Contributors

Name

ec_async_fail — Fails a message and removes it from the system

Synopsis

#include "sp_unlink.h"

| void **ec_async_fail** ( | vm, |   |
|   | force_async); |   |

ec_message * <var class="pdparam">vm</var>;
int <var class="pdparam">force_async</var>;

Description

Fails a message and removes it from the system.

Removes the message from the spool, logs a permanent failure and frees the message. After calling this function, you should assume that the message has been freed and should not be touched.

Parameters

vm

A pointer to an ec_message struct (the source message). For documentation of this data structure see “ec_message”

Return Values

This function returns void.

Threading

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