paa-http-server-facade.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_HTTP_SERVER_FACADE_H_
#define _PAA_SDK_HTTP_SERVER_FACADE_H_ 1

#include <stdlib.h>

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

#ifdef __cplusplus
extern "C" {
#endif

typedef struct paa_agent_response_struct paa_agent_response;

typedef struct paa_client_request_struct paa_client_request;

typedef size_t (*paa_client_request_read_cb)(unsigned char *dst,
                                             size_t size,
                                             void *userdata);

typedef apr_status_t (*paa_header_cb)(const char *name,
                                      const char *value,
                                      void *userdata);

struct paa_client_request_struct
{
    void *impl;

    const char *(*get_method)(const paa_client_request *req);

    const char *(*get_normalized_uri)(const paa_client_request *req);

    const char *(*get_raw_uri)(const paa_client_request *req);

    const char *(*get_remote_ip)(const paa_client_request *req);

    const char *(*get_scheme)(const paa_client_request *req);

     const char *(*get_scope)(const paa_client_request *req);

    apr_status_t (*enumerate_headers)(const paa_client_request *req,
                                      paa_header_cb cb,
                                      void *userdata);

    apr_status_t (*get_header_values)(const paa_client_request *req,
                                      const char *name,
                                      paa_header_cb cb,
                                      void *userdata);

    apr_status_t (*set_header)(const paa_client_request *req,
                               const char *name,
                               const char *value);

    apr_status_t (*add_header)(const paa_client_request *req,
                               const char *name,
                               const char *value);

    apr_status_t (*remove_header)(const paa_client_request *req,
                                  const char *name);

    apr_status_t (*set_req_var)(const paa_client_request *req,
                                const char *name,
                                const char *value);

    apr_status_t (*remove_req_var)(const paa_client_request *req,
                                   const char *name);

    apr_status_t (*set_user)(const paa_client_request *req, const char *user);

    const char *(*get_user)(const paa_client_request *req);

    // The following functions only need to be implemented when
    // the paa_client_request is used in conjunction with paa_http_client.

    paa_client_request_read_cb (*get_read_cb)(const paa_client_request *req);

    void *(*get_read_data)(const paa_client_request *req);
};

typedef struct paa_client_response_struct paa_client_response;

typedef size_t (*paa_client_response_write_cb)(const unsigned char *src,
                                               size_t size,
                                               void *userdata);

struct paa_client_response_struct
{
    void *impl;

    int (*get_status)(const paa_client_response *resp);

    apr_status_t (*set_header)(const paa_client_response *resp,
                               const char *name,
                               const char *value);

    apr_status_t (*add_header)(const paa_client_response *resp,
                               const char *name,
                               const char *value);

    apr_status_t (*remove_header)(const paa_client_response *resp,
                                  const char *name);

    apr_status_t (*enumerate_headers)(const paa_client_response *resp,
                                      paa_header_cb cb,
                                      void *userdata);


    // The following functions only need to be implemented when
    // the paa_client_response is used in conjunction with paa_http_client.

    apr_status_t (*replacing)(const paa_client_response *resp);

    apr_status_t (*set_status)(const paa_client_response *resp,
                               int status,
                               const char *reason);

    paa_client_response_write_cb (*get_write_cb)(const paa_client_response *resp);

    void *(*get_write_data)(const paa_client_response *resp);

};

#ifdef __cplusplus
} /* C */
#endif

#endif /* _PAA_SDK_HTTP_SERVER_FACADE_H_ */