lws-threadpool.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
 */
 
 
struct lws_threadpool;
struct lws_threadpool_task;
 
enum lws_threadpool_task_status {
        LWS_TP_STATUS_QUEUED,
        LWS_TP_STATUS_RUNNING,
        LWS_TP_STATUS_SYNCING,
        LWS_TP_STATUS_STOPPING,
        LWS_TP_STATUS_FINISHED, /* lws_threadpool_task_status() frees task */
        LWS_TP_STATUS_STOPPED, /* lws_threadpool_task_status() frees task */
};
 
enum lws_threadpool_task_return {
        LWS_TP_RETURN_CHECKING_IN,
        LWS_TP_RETURN_SYNC,
        LWS_TP_RETURN_FINISHED,
        LWS_TP_RETURN_STOPPED,
 
        /* OR on to indicate this task wishes to outlive its wsi */
        LWS_TP_RETURN_FLAG_OUTLIVE = 64
};
 
struct lws_threadpool_create_args {
        int threads;
        int max_queue_depth;
};
 
struct lws_threadpool_task_args {
        struct lws *wsi;        
        void *user;             
        const char *name;       
        char async_task;        
        enum lws_threadpool_task_return (*task)(void *user,
                                        enum lws_threadpool_task_status s);
        void (*cleanup)(struct lws *wsi, void *user);
};
 
LWS_VISIBLE LWS_EXTERN struct lws_threadpool *
lws_threadpool_create(struct lws_context *context,
                      const struct lws_threadpool_create_args *args,
                      const char *format, ...) LWS_FORMAT(3);
 
LWS_VISIBLE LWS_EXTERN void
lws_threadpool_finish(struct lws_threadpool *tp);
 
LWS_VISIBLE LWS_EXTERN void
lws_threadpool_destroy(struct lws_threadpool *tp);
 
LWS_VISIBLE LWS_EXTERN struct lws_threadpool_task *
lws_threadpool_enqueue(struct lws_threadpool *tp,
                       const struct lws_threadpool_task_args *args,
                       const char *format, ...) LWS_FORMAT(3);
 
LWS_VISIBLE LWS_EXTERN int
lws_threadpool_dequeue(struct lws *wsi);
 
LWS_VISIBLE LWS_EXTERN enum lws_threadpool_task_status
lws_threadpool_task_status_wsi(struct lws *wsi,
                               struct lws_threadpool_task **task, void **user);
 
LWS_VISIBLE LWS_EXTERN void
lws_threadpool_task_sync(struct lws_threadpool_task *task, int stop);
 
LWS_VISIBLE LWS_EXTERN void
lws_threadpool_dump(struct lws_threadpool *tp);