get_msg_expiration_params
Name
get_msg_expiration_params — Allows modules to customize the expiration parameters on a per-message basis
Synopsis
#include "hooks/core/get_msg_expiration_params.h"
| int **core_get_msg_expiration_params** (
| closure, | |
| | am, | |
| | message_expiration, | |
| | retry_interval, | |
| | max_retries)
; | |
void * <var class="pdparam">closure</var>
;
abstract_message * <var class="pdparam">am</var>
;
time_t * <var class="pdparam">message_expiration</var>
;
time_t * <var class="pdparam">retry_interval</var>
;
int * <var class="pdparam">max_retries</var>
;
Description
Allows modules to customize the expiration parameters on a per-message basis. The message_expiration
, retry_interval
and max_retries
parameters correspond to the Message_Expiration
, Retry_Interval
and Max_Retries
configuration parameters, respectively.
- closure
-
A pointer to the closure function.
- am
-
An
abstract_message
. For documentation of this data structure see “abstract_message” - message_expiration
-
Corresponds to the Message_Expiration configuration option.
- retry_interval
-
Corresponds to the Retry_Interval configuration option.
- max_retries
-
Corresponds to the Max_Retries configuration option.
If you decide to take no action (and simply want the default behavior), then return 0
. If you set any of the parameters, then return 1
.
This hook will be called in any thread.