master-service.h revision 32b78da5dfbbf6a06b3dbdc9278c60b55714f9bc
#ifndef MASTER_SERVICE_H
#define MASTER_SERVICE_H
#include "network.h"
enum master_service_flags {
MASTER_SERVICE_FLAG_STD_CLIENT = 0x01,
/* this process is currently running standalone without a master */
MASTER_SERVICE_FLAG_STANDALONE = 0x02,
/* Log to configured log file instead of stderr. By default when
_FLAG_STANDALONE is set, logging is done to stderr. */
/* Service is going to do multiple configuration lookups,
keep the connection to config service open. */
/* Don't read settings, but use whatever is in environment */
/* Use MASTER_LOGIN_NOTIFY_FD to track login overflow state */
/* If master sends SIGINT, don't die even if we don't have clients */
MASTER_SERVICE_FLAG_NO_IDLE_DIE = 0x80,
/* Show number of connections in process title
(only if verbose_proctitle setting is enabled) */
MASTER_SERVICE_FLAG_UPDATE_PROCTITLE = 0x100,
/* SSL settings are always looked up when we have ssl listeners.
This flag enables looking up SSL settings even without ssl
listeners (i.e. the service does STARTTLS). */
};
struct master_service_connection {
int fd;
int listen_fd;
const char *name;
unsigned int remote_port;
unsigned int fifo:1;
unsigned int ssl:1;
unsigned int accepted:1;
};
typedef void
extern struct master_service *master_service;
const char *master_service_getopt_string(void);
/* Start service initialization. */
struct master_service *
/* Call getopt() and handle internal parameters. Return values are the same as
getopt()'s. */
/* Parser command line option. Returns TRUE if processed. */
/* Finish service initialization. The caller should drop privileges
before calling this. */
/* Clean environment from everything except the ones listed in
DOVECOT_PRESERVE_ENVS environment. */
void master_service_env_clean(void);
/* Initialize logging. */
const char *prefix);
/* If set, die immediately when connection to master is lost.
Normally all existing clients are handled first. */
bool set);
/* Call the given when master connection dies and die_with_master is TRUE.
The callback is expected to shut down the service somewhat soon or it's
done forcibly. If NULL, the service is stopped immediately. */
void (*callback)(void));
/* "idle callback" is called when master thinks we're idling and asks us to
die. We'll do it only if the idle callback returns TRUE. This callback isn't
even called if the master service code knows that we're handling clients. */
bool (*callback)(void));
/* Call the given callback when there are no available connections and master
has indicated that it can't create any more processes to handle requests.
The callback could decide to kill one of the existing connections. */
void (*callback)(void));
/* Set maximum number of clients we can handle. Default is given by master. */
unsigned int client_limit);
/* Returns the maximum number of clients we can handle. */
/* Returns how many processes of this type can be created before reaching the
limit. */
/* Returns the service's idle_kill timeout in seconds. Normally master handles
sending the kill request when the process has no clients, but some services
with permanent client connections may need to handle this themselves. */
/* Set maximum number of client connections we will handle before shutting
down. */
unsigned int count);
/* Returns the number of client connections we will handle before shutting
down. The value is decreased only after connection has been closed. */
/* Return the number of listener sockets. */
/* Returns configuration file path. */
/* Returns PACKAGE_VERSION or NULL if version_ignore=yes. This function is
useful mostly as parameter to module_dir_load(). */
/* Returns name of the service, as given in name parameter to _init(). */
/* Start the service. Blocks until finished */
ATTR_NULL(2);
/* Stop a running service. */
/* Stop once we're done serving existing new connections, but don't accept
any new ones. */
/* Send command to anvil process, if we have fd to it. */
/* Call to accept the client connection. Otherwise the connection is closed. */
/* Used to create "extra client connections" outside the common accept()
method. */
/* Call whenever a client connection is destroyed. */
/* Deinitialize the service. */
/* Returns TRUE if line contains compatible service name and major version.
The line is expected to be in format:
VERSION <tab> service_name <tab> major version <tab> minor version */
unsigned major_version);
#endif