smfi_settimeout Function

Purpose

The smfi_settimeout function sets the filters I/O timeout value.

Syntax

#include <libmilter/mfapi.h>
int smfi_settimeout((
int otimeout
);

Description

The smfi_settimeout function is called only from smfi_main function. The smfi_settimeout function sets the duration (in seconds) for libmilter parameter to wait for a mail transfer agent (MTA) communication (read or write) before timing out.
Note: If the smfi_settimeout function is not called, the default timeout duration is 7210 seconds.

Arguments

Table 1. Arguments
Item Description
otimeout The duration in seconds for thelibmilter parameter to wait for an MTA before timing out. The otimeout value must be greater than zero. If the otimeout value is zero, the libmilter parameter does not wait for an MTA.

Return values

The smfi_settimeout function always returns the MI_SUCCESS value.

Related information

smfi_main