NAME
smfi_stop() — starts an orderly shutdown of the Milter for sendmail
SYNOPSIS
#include <libmilter/mfapi.h>
int smfi_stop(void);
PARAMETERS
- void
Specifies that the function does not accept any argument.
DESCRIPTION
The
smfi_stop()
routine causes each thread to finish its current
connection and then exit the connection.
When all the threads have exited, the call to the
smfi_main()
routine returns to the calling program, which may
then exit or warm restart the function.
smfi_stop()
can be
called from any callback routine or any error-handling routine
at any time in the program.
A new connection is not accepted
after calling
smfi_stop().
Notes
A Milter may also shutdown due the following reasons:
An internal routine may ask the Milter to abort.
Any other routine may also ask the Milter to stop.
The stop process cannot be canceled once it has begun.
RETURN VALUE
smfi_stop()
always returns
SMFI_CONTINUE.
AUTHOR
The
smfi_stop()
routine was developed by the Sendmail Inc.