paa-cache.h

Go to the documentation of this file.

/*****************************************************
 * Copyright (C) 2015 Ping Identity Corporation
 * All rights reserved.
 *
 * The contents of this file are the property of Ping Identity Corporation.
 * You may not copy or use this file, in either source code or executable
 * form, except in compliance with terms set by Ping Identity Corporation.
 * For further information please contact:
 *
 * Ping Identity Corporation
 * 1001 17th St Suite 100
 * Denver, CO 80202
 * 303.468.2900
 * http://www.pingidentity.com
 *
 ****************************************************/

#ifndef _PAA_SDK_PAA_CACHE_H_
#define _PAA_SDK_PAA_CACHE_H_ 1

#include "apr.h"
#include "apr_pools.h"

#include "paa-http-server-facade.h"
#include "paa-util.h"

#define APR_PAA_CACHE_HIT_CONSULT (APR_PAA_CACHE_START + 0)

#define APR_PAA_CACHE_HIT_UNPROTECTED (APR_PAA_CACHE_START + 1)

#define APR_PAA_CACHE_HIT_PROTECTED (APR_PAA_CACHE_START + 2)

#define APR_PAA_CACHE_RESOURCE_MISS (APR_PAA_CACHE_START + 3)

#define APR_PAA_CACHE_TOKEN_MISS (APR_PAA_CACHE_START + 4)

#define APR_PAA_CACHE_EXPIRED_MISS (APR_PAA_CACHE_START + 5)

#define APR_PAA_CACHE_NA (APR_PAA_CACHE_START + 6)

#define APR_PAA_CACHE_INVALID_MISS (APR_PAA_CACHE_START + 7)

#ifdef __cplusplus
extern "C" {
#endif

typedef struct paa_cache_struct paa_cache;

struct paa_cache_struct
{
    void *impl;

    apr_status_t (*get_agent_response)(const paa_cache *cache,
                                       apr_pool_t *pool,
                                       const paa_client_request *req,
                                       const paa_agent_response **output);

    apr_status_t (*put_agent_response)(const paa_cache *cache,
                                       apr_pool_t *pool,
                                       const paa_client_request *req,
                                       const paa_agent_response *agent_resp);

    apr_status_t (*invalidate_scope)(const paa_cache *cache,
                                     apr_pool_t *request_pool,
                                     const char *scope);
};

#ifdef __cplusplus
} /* C */
#endif

#endif /* _PAA_SDK_PAA_CACHE_H_ */