nunc-stans.h

Go to the documentation of this file.

/* --- BEGIN COPYRIGHT BLOCK ---
 * Copyright (C) 2015  Red Hat
 * see files 'COPYING' and 'COPYING.openssl' for use and warranty
 * information
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Additional permission under GPLv3 section 7:
 * 
 * If you modify this Program, or any covered work, by linking or
 * combining it with OpenSSL, or a modified version of OpenSSL licensed
 * under the OpenSSL license
 * (https://www.openssl.org/source/license.html), the licensors of this
 * Program grant you additional permission to convey the resulting
 * work. Corresponding Source for a non-source form of such a
 * combination shall include the source code for the parts that are
 * licensed under the OpenSSL license as well as that of the covered
 * work.
 * --- END COPYRIGHT BLOCK ---
 */
#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

#ifndef NS_THRPOOL_H

#define NS_THRPOOL_H

#include "nspr.h"

struct ns_thrpool_t;
typedef struct ns_thrpool_t ns_thrpool_t;

struct ns_job_t;

typedef void (*ns_job_func_t)(struct ns_job_t *);

#define NS_JOB_NONE 0x0

#define NS_JOB_ACCEPT 0x1

#define NS_JOB_CONNECT 0x2

#define NS_JOB_READ 0x4

#define NS_JOB_WRITE 0x8

#define NS_JOB_TIMER 0x10

#define NS_JOB_SIGNAL 0x20

#define NS_JOB_PERSIST 0x40

#define NS_JOB_THREAD 0x80

#define NS_JOB_PRESERVE_FD 0x100

typedef unsigned short ns_job_type_t;

#define NS_JOB_IS_ACCEPT(eee) ((eee)&NS_JOB_ACCEPT)

#define NS_JOB_IS_READ(eee) ((eee)&NS_JOB_READ)

#define NS_JOB_IS_CONNECT(eee) ((eee)&NS_JOB_CONNECT)

#define NS_JOB_IS_WRITE(eee) ((eee)&NS_JOB_WRITE)

#define NS_JOB_IS_TIMER(eee) ((eee)&NS_JOB_TIMER)

#define NS_JOB_IS_SIGNAL(eee) ((eee)&NS_JOB_SIGNAL)

#define NS_JOB_IS_PERSIST(eee) ((eee)&NS_JOB_PERSIST)

#define NS_JOB_IS_IO(eee) (NS_JOB_IS_ACCEPT(eee)||NS_JOB_IS_READ(eee)||NS_JOB_IS_CONNECT(eee)||NS_JOB_IS_WRITE(eee))

#define NS_JOB_IS_THREAD(eee) ((eee)&NS_JOB_THREAD)

#define NS_JOB_IS_PRESERVE_FD(eee) ((eee)&NS_JOB_PRESERVE_FD)

#define NS_JOB_SET_READ(eee) ((eee) |= NS_JOB_READ)

#define NS_JOB_SET_WRITE(eee) ((eee) |= NS_JOB_WRITE)

#define NS_JOB_SET_THREAD(eee) ((eee) |= NS_JOB_THREAD)

#define NS_JOB_UNSET_READ(eee) ((eee) &= ~NS_JOB_READ)

#define NS_JOB_UNSET_WRITE(eee) ((eee) &= ~NS_JOB_WRITE)

#define NS_JOB_UNSET_THREAD(eee) ((eee) &= ~NS_JOB_THREAD)

struct ns_thrpool_config {
    int init_flag;
    PRInt32 max_threads; 
    PRUint32 stacksize; 
    /* pluggable logging functions  */
    void (*log_fct)(int, const char *, va_list); 
    void (*log_start_fct)( void ); 
    void (*log_close_fct)( void ); 
    /* pluggable memory functions */
    void* (*malloc_fct)(size_t); 
    void* (*memalign_fct)(size_t size, size_t alignment); 
    void* (*calloc_fct)(size_t, size_t); 
    void* (*realloc_fct)(void *, size_t); 
    void (*free_fct)(void *); 
};

void ns_thrpool_config_init(struct ns_thrpool_config *tp_config);

PRStatus ns_job_done(struct ns_job_t *job);

PRStatus
ns_create_job(struct ns_thrpool_t *tp, ns_job_type_t job_type, ns_job_func_t func, struct ns_job_t **job);

PRStatus ns_add_io_job(struct ns_thrpool_t *tp,
                       PRFileDesc *fd,
                       ns_job_type_t job_type,
                       ns_job_func_t func,
                       void *data,
                       struct ns_job_t **job);

PRStatus ns_add_timeout_job(struct ns_thrpool_t *tp,
                            struct timeval *tv,
                            ns_job_type_t job_type,
                            ns_job_func_t func,
                            void *data,
                            struct ns_job_t **job);

PRStatus ns_add_io_timeout_job(struct ns_thrpool_t *tp,
                               PRFileDesc *fd,
                               struct timeval *tv,
                               ns_job_type_t job_type,
                               ns_job_func_t func,
                               void *data,
                               struct ns_job_t **job);

PRStatus ns_add_signal_job(ns_thrpool_t *tp,
                           PRInt32 signum,
                           ns_job_type_t job_type,
                           ns_job_func_t func,
                           void *data,
                           struct ns_job_t **job);

PRStatus ns_add_job(ns_thrpool_t *tp, ns_job_type_t job_type, ns_job_func_t func, void *data, struct ns_job_t **job);

PRFileDesc *ns_job_get_fd(struct ns_job_t *job);

void *ns_job_get_data(struct ns_job_t *job);

PRStatus ns_job_set_data(struct ns_job_t *job, void *data);

ns_job_type_t ns_job_get_type(struct ns_job_t *job);

ns_thrpool_t *ns_job_get_tp(struct ns_job_t *job);

ns_job_type_t ns_job_get_output_type(struct ns_job_t *job);

PRStatus ns_job_set_done_cb(struct ns_job_t *job, ns_job_func_t func);

struct ns_thrpool_t *ns_thrpool_new(struct ns_thrpool_config *config);

void ns_thrpool_destroy(struct ns_thrpool_t *tp);

void ns_thrpool_shutdown(struct ns_thrpool_t *tp);

PRInt32 ns_thrpool_is_shutdown(struct ns_thrpool_t *tp);

PRStatus ns_thrpool_wait(struct ns_thrpool_t *tp);


PRStatus ns_job_rearm(struct ns_job_t *job);

#endif /* NS_THRPOOL_H */