cluster.h

Go to the documentation of this file.

/*
 *   This program is is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or (at
 *   your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
 */

/**
 * $Id: 6455947cb2d7987e776342f2dac7e535f0580a20 $
 * @file cluster.h
 * @brief Common functions for interacting with Redis cluster via Hiredis
 *
 * @author Arran Cudbard-Bell
 *
 * @copyright 2015 Arran Cudbard-Bell <a.cudbardb@freeradius.org>
 * @copyright 2015 Network RADIUS <info@networkradius.com>
 * @copyright 2015 The FreeRADIUS server project
 */

#ifndef LIBFREERADIUS_REDIS_CLUSTER_H
#define LIBFREERADIUS_REDIS_CLUSTER_H

RCSIDH(cluster_h, "$Id: 6455947cb2d7987e776342f2dac7e535f0580a20 $")

typedef struct fr_redis_cluster fr_redis_cluster_t;

/** Redis connection sequence state
 *
 * Tracks how many operations we've performed attempting to execute a single command.
 *
 * Used by callers of the cluster code.  Allocated on the stack and passed to
 * #fr_redis_cluster_state_init and #fr_redis_cluster_state_next.
 */
typedef struct fr_redis_cluster_state {
        bool                    close_conn;     //!< Set by caller of fr_redis_cluster_state_next,
                                                //!< to indicate that connection must be closed, as it's
                                                //!< now in an unknown state.

        uint8_t const           *key;           //!< Key we performed hashing on.
        size_t                  key_len;        //!< Length of the key.

        struct fr_redis_cluster_node *node;     //!< Node we're communicating with.
        uint32_t                redirects;      //!< How many redirects have we followed.

        uint32_t                retries;        //!< How many time's we've received TRYAGAIN
        uint32_t                in_pool;        //!< How many available connections are there in the pool.
        uint32_t                reconnects;     //!< How many connections we've tried in this pool.
} fr_redis_cluster_state_t;

/*
 *      Callback for the connection pool to create a new connection
 */
void *fr_redis_cluster_conn_create(TALLOC_CTX *ctx, void *instance, struct timeval const *timeout);

/*
 *      Reserve/release connections, follow redirects, reconnect
 *      connections implement retry delays.
 */
fr_redis_rcode_t fr_redis_cluster_state_init(fr_redis_cluster_state_t *state, fr_redis_conn_t **conn,
                                             fr_redis_cluster_t *cluster,  REQUEST *request,
                                             uint8_t const *key, size_t key_len, bool read_only);

fr_redis_rcode_t fr_redis_cluster_state_next(fr_redis_cluster_state_t *state, fr_redis_conn_t **conn,
                                             fr_redis_cluster_t *cluster, REQUEST *request,
                                             fr_redis_rcode_t status, redisReply **reply);

/*
 *      Testing only
 */
int fr_redis_cluster_pool_by_node_addr(fr_connection_pool_t **pool, fr_redis_cluster_t *cluster,
                                       fr_ipaddr_t *ipaddr, uint16_t port, bool create);

/*
 *      Initialise a new cluster connection, and perform initial mapping.
 */
bool fr_redis_cluster_min_version(fr_redis_cluster_t *cluster, char const *min_version);

fr_redis_cluster_t *fr_redis_cluster_alloc(TALLOC_CTX *ctx, CONF_SECTION *cs, fr_redis_conf_t *conf);

#endif  /* LIBFREERADIUS_REDIS_CLUSTER_H */