pianod2/Doxygen/fb__transport_8h_source.html

 #ifndef __football__transport__

 #define __football__transport__


 #include <config.h>


 #include "fb_public.h"


 #define FB_HAVE_TLS

 #if defined(HAVE_LIBGNUTLS)


 #include <gnutls/gnutls.h>

 typedef gnutls_session_t FB_TLS_CONTEXT;


 #elif defined(HAVE_LIBMBEDTLS)


 #pragma GCC diagnostic push

 #pragma GCC diagnostic ignored "-Wdocumentation"

 #include <mbedtls/ssl.h>

 #pragma GCC diagnostic pop


 typedef struct fb_tls_context_t {

     mbedtls_ssl_context context;

     bool pending_read;

     unsigned char buffered_char;

 } FB_TLS_CONTEXT;


 #elif defined(HAVE_LIBTLS)


 typedef struct fb_tls_context_t {

     struct tls *context;

     bool pending_read;

     char buffered_char;

 } FB_TLS_CONTEXT;


 #elif defined(HAVE_LIBSSL)


 #include <openssl/ssl.h>


 typedef SSL *FB_TLS_CONTEXT;


 #elif defined(HAVE_SECURETRANSPORT)


 #include <Security/SecureTransport.h>


 typedef SSLContextRef FB_TLS_CONTEXT;


 #else

 #undef FB_HAVE_TLS

 #endif


 extern const ssize_t FB_TRANSPORT_CLOSED;

 extern const ssize_t FB_TRANSPORT_INCOMPLETE;

 extern const ssize_t FB_TRANSPORT_FAILURE;


 typedef struct fb_config_files_t {

     char *public_key_name;

     char *x509_certificate_name;

     char *x509_revokation_name;

 } FB_TLS_CONFIG_FILENAMES;


 typedef struct fb_transport_funcs_t {

     bool (*configure) (const FB_TLS_CONFIG_FILENAMES *files);

     void (*cleanup) ();


     bool (*init) (FB_CONNECTION *connection);

     ssize_t (*handshake) (struct fb_connection_t *connection);

     ssize_t (*buffering) (struct fb_connection_t *connection);

     ssize_t (*read) (struct fb_connection_t *connection, char *data, ssize_t byte_count);

     ssize_t (*write) (struct fb_connection_t *connection, const char *data, ssize_t byte_count);

     void (*done) (FB_CONNECTION *connection);

 } FB_TRANSPORT_FUNCS;


 extern const FB_TRANSPORT_FUNCS fb_transport_unencrypted;

 extern const FB_TRANSPORT_FUNCS fb_transport_read_file;

 #ifdef FB_HAVE_TLS

 extern const FB_TRANSPORT_FUNCS fb_transport_encrypted;

 #endif


 #endif /* defined(__football__transport__) */

fb_public.h
Football public declarations.

fb_transport_unencrypted
const FB_TRANSPORT_FUNCS fb_transport_unencrypted
Transport virtual method table for unenrypted connections.
Definition: fb_transport.c:104

FB_TRANSPORT_INCOMPLETE
const ssize_t FB_TRANSPORT_INCOMPLETE
An action was incomplete, but can be retried in the future.
Definition: fb_transport.c:35

FB_TRANSPORT_FUNCS
struct fb_transport_funcs_t FB_TRANSPORT_FUNCS

fb_transport_read_file
const FB_TRANSPORT_FUNCS fb_transport_read_file
Transport virtual method table for reading from files.
Definition: fb_transport.c:159

FB_TRANSPORT_FAILURE
const ssize_t FB_TRANSPORT_FAILURE
An action failed permanently; the connection has failed and should be closed.
Definition: fb_transport.c:38

FB_TRANSPORT_CLOSED
const ssize_t FB_TRANSPORT_CLOSED
Connection closed normally. Returned by read transport function only.
Definition: fb_transport.c:32

FB_TLS_CONFIG_FILENAMES
struct fb_config_files_t FB_TLS_CONFIG_FILENAMES
Structure with various I/O functions.

fb_transport_encrypted
const FB_TRANSPORT_FUNCS fb_transport_encrypted
Definition: fb_transport_gnutls.c:174

fb_config_files_t
Structure with various I/O functions.
Definition: fb_transport.h:68

fb_config_files_t::x509_revokation_name
char * x509_revokation_name
Definition: fb_transport.h:71

fb_config_files_t::public_key_name
char * public_key_name
Definition: fb_transport.h:69

fb_config_files_t::x509_certificate_name
char * x509_certificate_name
Definition: fb_transport.h:70

fb_connection_t
Connection state information.
Definition: fb_service.h:199

fb_transport_funcs_t
Definition: fb_transport.h:74

fb_transport_funcs_t::done
void(* done)(FB_CONNECTION *connection)
Clean up a closing connection.
Definition: fb_transport.h:91

fb_transport_funcs_t::cleanup
void(* cleanup)()
One-time teardown before exit. Not called per-connection.
Definition: fb_transport.h:78

fb_transport_funcs_t::init
bool(* init)(FB_CONNECTION *connection)
Initialize a new connection. Return true on success, 0 on failure.
Definition: fb_transport.h:81

fb_transport_funcs_t::write
ssize_t(* write)(struct fb_connection_t *connection, const char *data, ssize_t byte_count)
Write data to a connection. Return incomplete, failure, or bytes written (0 is not an error).
Definition: fb_transport.h:89

fb_transport_funcs_t::buffering
ssize_t(* buffering)(struct fb_connection_t *connection)
Query number of bytes in TLS buffers.
Definition: fb_transport.h:85

fb_transport_funcs_t::configure
bool(* configure)(const FB_TLS_CONFIG_FILENAMES *files)
One-time initialization on startup. Not called per-connection.
Definition: fb_transport.h:76

fb_transport_funcs_t::handshake
ssize_t(* handshake)(struct fb_connection_t *connection)
Perform TLS handshaking on a new connection. Return incomplete, failure, or 0.
Definition: fb_transport.h:83

fb_transport_funcs_t::read
ssize_t(* read)(struct fb_connection_t *connection, char *data, ssize_t byte_count)
Read data from a connection. Return transport constant or bytes read.
Definition: fb_transport.h:87