lws-spa.h

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010-2018 Andy Green <andy@warmcat.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation:
 *  version 2.1 of the License.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 *  MA  02110-1301  USA
 *
 * included from libwebsockets.h
 */
 
 
enum lws_spa_fileupload_states {
        LWS_UFS_CONTENT,
        LWS_UFS_FINAL_CONTENT,
        LWS_UFS_OPEN,
        LWS_UFS_CLOSE
};
 
typedef int (*lws_spa_fileupload_cb)(void *data, const char *name,
                                     const char *filename, char *buf, int len,
                                     enum lws_spa_fileupload_states state);
 
struct lws_spa;
 
LWS_VISIBLE LWS_EXTERN struct lws_spa *
lws_spa_create(struct lws *wsi, const char * const *param_names,
               int count_params, int max_storage, lws_spa_fileupload_cb opt_cb,
               void *opt_data);
 
typedef struct lws_spa_create_info {
        const char * const *param_names; /* array of form parameter names, like "username" */
        int count_params; /* count of param_names */
        int max_storage; /* total amount of form parameter values we can store */
        lws_spa_fileupload_cb opt_cb; /* NULL, or callback to receive file upload data. */
        void *opt_data; /* NULL, or user pointer provided to opt_cb. */
        size_t param_names_stride; /* 0 if param_names is an array of char *.
                                        Else stride to next char * */
        struct lwsac **ac;      /* NULL, or pointer to lwsac * to contain all
                                   related heap allocations */
        size_t ac_chunk_size;   /* 0 for default, or ac chunk size */
} lws_spa_create_info_t;
 
LWS_VISIBLE LWS_EXTERN struct lws_spa *
lws_spa_create_via_info(struct lws *wsi, const lws_spa_create_info_t *info);
 
LWS_VISIBLE LWS_EXTERN int
lws_spa_process(struct lws_spa *spa, const char *in, int len);
 
LWS_VISIBLE LWS_EXTERN int
lws_spa_finalize(struct lws_spa *spa);
 
LWS_VISIBLE LWS_EXTERN int
lws_spa_get_length(struct lws_spa *spa, int n);
 
LWS_VISIBLE LWS_EXTERN const char *
lws_spa_get_string(struct lws_spa *spa, int n);
 
LWS_VISIBLE LWS_EXTERN int
lws_spa_destroy(struct lws_spa *spa);