lws-spa.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2019 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
 
 
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; 
        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);