diff options
Diffstat (limited to 'src/libutil/upstream.h')
| -rw-r--r-- | src/libutil/upstream.h | 140 |
1 files changed, 70 insertions, 70 deletions
diff --git a/src/libutil/upstream.h b/src/libutil/upstream.h index 492209649..08796a1f9 100644 --- a/src/libutil/upstream.h +++ b/src/libutil/upstream.h @@ -6,7 +6,7 @@ #include "rdns.h" #include "ucl.h" -#ifdef __cplusplus +#ifdef __cplusplus extern "C" { #endif @@ -34,20 +34,20 @@ struct upstream_ctx; * Init upstreams library * @param resolver */ -struct upstream_ctx *rspamd_upstreams_library_init (void); +struct upstream_ctx *rspamd_upstreams_library_init(void); /** * Remove reference from upstreams library */ -void rspamd_upstreams_library_unref (struct upstream_ctx *ctx); +void rspamd_upstreams_library_unref(struct upstream_ctx *ctx); /** * Configure attributes of upstreams library * @param cfg */ -void rspamd_upstreams_library_config (struct rspamd_config *cfg, - struct upstream_ctx *ctx, struct ev_loop *event_loop, - struct rdns_resolver *resolver); +void rspamd_upstreams_library_config(struct rspamd_config *cfg, + struct upstream_ctx *ctx, struct ev_loop *event_loop, + struct rdns_resolver *resolver); /** * Upstream error logic @@ -60,32 +60,32 @@ void rspamd_upstreams_library_config (struct rspamd_config *cfg, /** * Add an error to an upstream */ -void rspamd_upstream_fail (struct upstream *upstream, gboolean addr_failure, const gchar *reason); +void rspamd_upstream_fail(struct upstream *upstream, gboolean addr_failure, const gchar *reason); /** * Increase upstream successes count */ -void rspamd_upstream_ok (struct upstream *up); +void rspamd_upstream_ok(struct upstream *up); /** * Set weight for an upstream * @param up */ -void rspamd_upstream_set_weight (struct upstream *up, guint weight); +void rspamd_upstream_set_weight(struct upstream *up, guint weight); /** * Create new list of upstreams * @return */ -struct upstream_list *rspamd_upstreams_create (struct upstream_ctx *ctx); +struct upstream_list *rspamd_upstreams_create(struct upstream_ctx *ctx); /** * Sets specific flag to the upstream list * @param ups * @param flags */ -void rspamd_upstreams_set_flags (struct upstream_list *ups, - enum rspamd_upstream_flag flags); +void rspamd_upstreams_set_flags(struct upstream_list *ups, + enum rspamd_upstream_flag flags); /** * Sets custom limits for upstreams @@ -99,41 +99,41 @@ void rspamd_upstreams_set_flags (struct upstream_list *ups, * @param max_errors * @param dns_retransmits */ -void rspamd_upstreams_set_limits (struct upstream_list *ups, - gdouble revive_time, - gdouble revive_jitter, - gdouble error_time, - gdouble dns_timeout, - guint max_errors, - guint dns_retransmits); +void rspamd_upstreams_set_limits(struct upstream_list *ups, + gdouble revive_time, + gdouble revive_jitter, + gdouble error_time, + gdouble dns_timeout, + guint max_errors, + guint dns_retransmits); /** * Sets rotation policy for upstreams list * @param ups * @param rot */ -void rspamd_upstreams_set_rotation (struct upstream_list *ups, - enum rspamd_upstream_rotation rot); +void rspamd_upstreams_set_rotation(struct upstream_list *ups, + enum rspamd_upstream_rotation rot); /** * Destroy list of upstreams * @param ups */ -void rspamd_upstreams_destroy (struct upstream_list *ups); +void rspamd_upstreams_destroy(struct upstream_list *ups); /** * Returns count of upstreams in a list * @param ups * @return */ -gsize rspamd_upstreams_count (struct upstream_list *ups); +gsize rspamd_upstreams_count(struct upstream_list *ups); /** * Returns the number of upstreams in the list * @param ups * @return */ -gsize rspamd_upstreams_alive (struct upstream_list *ups); +gsize rspamd_upstreams_alive(struct upstream_list *ups); enum rspamd_upstream_parse_type { RSPAMD_UPSTREAM_PARSE_DEFAULT = 0, @@ -148,9 +148,9 @@ enum rspamd_upstream_parse_type { * @param data optional userdata * @return TRUE if upstream has been added */ -gboolean rspamd_upstreams_add_upstream (struct upstream_list *ups, const gchar *str, - guint16 def_port, enum rspamd_upstream_parse_type parse_type, - void *data); +gboolean rspamd_upstreams_add_upstream(struct upstream_list *ups, const gchar *str, + guint16 def_port, enum rspamd_upstream_parse_type parse_type, + void *data); /** * Add multiple upstreams from comma, semicolon or space separated line @@ -160,14 +160,14 @@ gboolean rspamd_upstreams_add_upstream (struct upstream_list *ups, const gchar * * @param data optional userdata * @return TRUE if **any** of upstreams has been added */ -gboolean rspamd_upstreams_parse_line (struct upstream_list *ups, - const gchar *str, guint16 def_port, void *data); +gboolean rspamd_upstreams_parse_line(struct upstream_list *ups, + const gchar *str, guint16 def_port, void *data); -gboolean rspamd_upstreams_parse_line_len (struct upstream_list *ups, - const gchar *str, gsize len, - guint16 def_port, - void *data); +gboolean rspamd_upstreams_parse_line_len(struct upstream_list *ups, + const gchar *str, gsize len, + guint16 def_port, + void *data); /** * Parse upstreams list from the UCL object @@ -177,12 +177,12 @@ gboolean rspamd_upstreams_parse_line_len (struct upstream_list *ups, * @param data * @return */ -gboolean rspamd_upstreams_from_ucl (struct upstream_list *ups, - const ucl_object_t *in, guint16 def_port, void *data); +gboolean rspamd_upstreams_from_ucl(struct upstream_list *ups, + const ucl_object_t *in, guint16 def_port, void *data); -typedef void (*rspamd_upstream_traverse_func) (struct upstream *up, guint idx, - void *ud); +typedef void (*rspamd_upstream_traverse_func)(struct upstream *up, guint idx, + void *ud); /** * Traverse upstreams list calling the function specified @@ -190,8 +190,8 @@ typedef void (*rspamd_upstream_traverse_func) (struct upstream *up, guint idx, * @param cb * @param ud */ -void rspamd_upstreams_foreach (struct upstream_list *ups, - rspamd_upstream_traverse_func cb, void *ud); +void rspamd_upstreams_foreach(struct upstream_list *ups, + rspamd_upstream_traverse_func cb, void *ud); enum rspamd_upstreams_watch_event { RSPAMD_UPSTREAM_WATCH_SUCCESS = 1u << 0, @@ -201,10 +201,10 @@ enum rspamd_upstreams_watch_event { RSPAMD_UPSTREAM_WATCH_ALL = (1u << 0) | (1u << 1) | (1u << 2) | (1u << 3), }; -typedef void (*rspamd_upstream_watch_func) (struct upstream *up, - enum rspamd_upstreams_watch_event event, - guint cur_errors, - void *ud); +typedef void (*rspamd_upstream_watch_func)(struct upstream *up, + enum rspamd_upstreams_watch_event event, + guint cur_errors, + void *ud); /** * Adds new watcher to the upstreams list @@ -213,47 +213,47 @@ typedef void (*rspamd_upstream_watch_func) (struct upstream *up, * @param func * @param ud */ -void rspamd_upstreams_add_watch_callback (struct upstream_list *ups, - enum rspamd_upstreams_watch_event events, - rspamd_upstream_watch_func func, - GFreeFunc free_func, - gpointer ud); +void rspamd_upstreams_add_watch_callback(struct upstream_list *ups, + enum rspamd_upstreams_watch_event events, + rspamd_upstream_watch_func func, + GFreeFunc free_func, + gpointer ud); /** * Returns the next IP address of the upstream (internal rotation) * @param up * @return */ -rspamd_inet_addr_t *rspamd_upstream_addr_next (struct upstream *up); +rspamd_inet_addr_t *rspamd_upstream_addr_next(struct upstream *up); /** * Returns the current IP address of the upstream * @param up * @return */ -rspamd_inet_addr_t *rspamd_upstream_addr_cur (const struct upstream *up); +rspamd_inet_addr_t *rspamd_upstream_addr_cur(const struct upstream *up); /** * Add custom address for an upstream (ownership of addr is transferred to upstream) * @param up * @return */ -gboolean rspamd_upstream_add_addr (struct upstream *up, - rspamd_inet_addr_t *addr); +gboolean rspamd_upstream_add_addr(struct upstream *up, + rspamd_inet_addr_t *addr); /** * Returns the symbolic name of the upstream * @param up * @return */ -const gchar *rspamd_upstream_name (struct upstream *up); +const gchar *rspamd_upstream_name(struct upstream *up); /** * Returns the port of the current address for the upstream * @param up * @return */ -gint rspamd_upstream_port (struct upstream *up); +gint rspamd_upstream_port(struct upstream *up); /** * Sets opaque user data associated with this upstream @@ -261,14 +261,14 @@ gint rspamd_upstream_port (struct upstream *up); * @param data * @return old data */ -gpointer rspamd_upstream_set_data (struct upstream *up, gpointer data); +gpointer rspamd_upstream_set_data(struct upstream *up, gpointer data); /** * Gets opaque user data associated with this upstream * @param up * @return */ -gpointer rspamd_upstream_get_data (struct upstream *up); +gpointer rspamd_upstream_get_data(struct upstream *up); /** * Get new upstream from the list @@ -276,9 +276,9 @@ gpointer rspamd_upstream_get_data (struct upstream *up); * @param type type of rotation algorithm, for `RSPAMD_UPSTREAM_HASHED` it is required to specify `key` and `keylen` as arguments * @return */ -struct upstream *rspamd_upstream_get (struct upstream_list *ups, - enum rspamd_upstream_rotation default_type, - const guchar *key, gsize keylen); +struct upstream *rspamd_upstream_get(struct upstream_list *ups, + enum rspamd_upstream_rotation default_type, + const guchar *key, gsize keylen); /** * Get new upstream from the list @@ -286,9 +286,9 @@ struct upstream *rspamd_upstream_get (struct upstream_list *ups, * @param type type of rotation algorithm, for `RSPAMD_UPSTREAM_HASHED` it is required to specify `key` and `keylen` as arguments * @return */ -struct upstream *rspamd_upstream_get_forced (struct upstream_list *ups, - enum rspamd_upstream_rotation forced_type, - const guchar *key, gsize keylen); +struct upstream *rspamd_upstream_get_forced(struct upstream_list *ups, + enum rspamd_upstream_rotation forced_type, + const guchar *key, gsize keylen); /** * Get new upstream from the list excepting the upstream specified @@ -296,29 +296,29 @@ struct upstream *rspamd_upstream_get_forced (struct upstream_list *ups, * @param type type of rotation algorithm, for `RSPAMD_UPSTREAM_HASHED` it is required to specify `key` and `keylen` as arguments * @return */ -struct upstream *rspamd_upstream_get_except (struct upstream_list *ups, - struct upstream *except, - enum rspamd_upstream_rotation default_type, - const guchar *key, gsize keylen); +struct upstream *rspamd_upstream_get_except(struct upstream_list *ups, + struct upstream *except, + enum rspamd_upstream_rotation default_type, + const guchar *key, gsize keylen); /** * Re-resolve addresses for all upstreams registered */ -void rspamd_upstream_reresolve (struct upstream_ctx *ctx); +void rspamd_upstream_reresolve(struct upstream_ctx *ctx); /** * Share ownership on upstream * @param up * @return */ -struct upstream* rspamd_upstream_ref (struct upstream *up); +struct upstream *rspamd_upstream_ref(struct upstream *up); /** * Unshare ownership on upstream * @param up */ -void rspamd_upstream_unref (struct upstream *up); +void rspamd_upstream_unref(struct upstream *up); -#ifdef __cplusplus +#ifdef __cplusplus } #endif |