fb_public.h

Go to the documentation of this file.

 
#pragma once
 
#include <config.h>
 
#include <stdarg.h>
#include <stdbool.h>
#include "stdarg.h"
#include <sys/types.h>
#include <netinet/in.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum fb_event_type_t {
    FB_EVENT_CONNECT = 1,   
    FB_EVENT_INPUT,         
    FB_EVENT_CLOSE,         
    FB_EVENT_STOPPED,       
    FB_EVENT_ITERATOR,      
    FB_EVENT_ITERATOR_CLOSE,
    FB_EVENT_WRITABLE,      
    FB_EVENT_READABLE,      
    FB_EVENT_FAULTING,      
    FB_EVENT_TIMEOUT,       
    FB_EVENT_INTERRUPT      
} FB_EVENTTYPE;
 
typedef struct fb_event_t {
    int magic;  /* Enums and ints are same thing, right? :( TODO: Fix this. */
    FB_EVENTTYPE type;
    int socket; 
    void *context; 
    struct fb_connection_t *connection; 
    struct fb_service_t *service; 
    char *command; 
    int argc; 
    char **argv; 
    int param_count; 
    char **param_names; 
    char **param_values; 
} FB_EVENT;
 
typedef enum fb_service_greeting_mode_t {
    FB_GREETING_OFF, 
    FB_GREETING_ALLOW, 
    FB_GREETING_FALLBACK, 
    FB_GREETING_REQUIRE 
} FB_GREETING_MODE;
 
typedef enum fb_internationalizaton_mode_t {
    FB_INTERNATIONALIZATION_NONE, 
    FB_INTERNATIONALIZATION_EXTENSION, 
    FB_INTERNATIONALIZATION_DIRECTORY 
} FB_I18N_MODE;
 
typedef struct fb_service_options_t {
    int line_port; 
    int http_port; 
    int https_port; 
    int queue_size; 
    size_t context_size; 
    char *greeting; 
    char *name; 
    char *serve_directory; 
    char *locale_directory; 
    time_t websocket_ping_interval; 
    FB_I18N_MODE internationalization; 
    FB_GREETING_MODE greeting_mode; 
    bool transfer_only; 
    struct fb_service_t *parent; 
} FB_SERVICE_OPTIONS;
 
typedef struct fb_service_t FB_SERVICE;
typedef struct fb_connection_t FB_CONNECTION;
typedef struct fb_iterator_t FB_ITERATOR;
 
#ifdef NDEBUG
typedef void (* FB_LOGGING_FUNCTION)(int level, const char *format, ...);
#else
typedef void (* FB_LOGGING_FUNCTION)(const char *file, int line, const char *func, int level, const char *format, ...);
#endif
extern void fb_set_logging (int logtype, FB_LOGGING_FUNCTION func);
extern FB_LOGGING_FUNCTION fb_log;
 
/* Useful utility functions available */
extern bool fb_expandcalloc (void **data, size_t *count, size_t newcount, size_t itemsize);
 
/* "Legitimate", i.e. published API, subroutines */
extern FB_EVENT *fb_wait (void);
extern FB_EVENT *fb_poll (void);
extern FB_EVENT *fb_poll_until (time_t untilwhen);
extern FB_EVENT *fb_poll_with_timeout (double timeout);
extern void fb_interrupt (void);
 
extern FB_SERVICE *fb_create_service (const FB_SERVICE_OPTIONS *options);
extern bool fb_transfer (FB_CONNECTION *connection, FB_SERVICE *service);
extern bool fb_services_are_open (void);
extern void fb_close_service (FB_SERVICE *service);
extern bool fb_init_tls_support (const char *path);
    extern void fb_cleanup_tls_support (void);
 
extern FB_EVENT *fb_accept_file (FB_SERVICE *service, char *filename);
extern FB_EVENT *fb_loopback_socket (FB_SERVICE *service);
extern void fb_close_connection (FB_CONNECTION *connection);
extern ssize_t fb_fprint (void *thing, const char *bytes, ssize_t length);
extern ssize_t fb_fprintf (void *thing, const char *format, ...);
extern ssize_t fb_vfprintf (void *thing, const char *format, va_list parameters);
extern ssize_t fb_bfprintf (void *thing, const char *format, ...);
extern ssize_t fb_bvfprintf (void *thing, const char *format, va_list parameters);
extern ssize_t fb_cbfprintf (void *thing, bool (*callback) (FB_CONNECTION *), const char *format, ...);
extern ssize_t fb_cbvfprintf (void *thing, bool (*callback) (FB_CONNECTION *), const char *format, va_list parameters);
 
extern FB_ITERATOR *fb_new_iterator (FB_SERVICE *service);
extern FB_EVENT *fb_iterate_next (struct fb_iterator_t *it);
extern void fb_destroy_iterator (FB_ITERATOR *it);
extern void fb_accept_input (FB_CONNECTION *connection, bool input);
 
#ifdef __cplusplus
}
#endif