ulfius Download - ulfius -Quellcode herunterladen

ulfius

C#-Quellcode

Release 2.7.15

Herunterladen

Ulfius HTTP Framework

HTTP-Framework für REST-Anwendungen in C.

Basierend auf GNU Libmicrohttpd für den Backend-Webserver, Jansson für die JSON-Manipulationsbibliothek und Libcurl für die http/smtp-Client-API.

Wird verwendet, um die Erstellung von Webanwendungen in C-Programmen mit geringem Speicherbedarf zu erleichtern, wie z. B. in eingebetteten Systemanwendungen.

Sie können Webservices im HTTP- oder HTTPS-Modus erstellen, Daten streamen oder Server-Websockets implementieren.

Hallo Welt! Beispielanwendung

Der Quellcode einer Hallo-Welt mit Ulfius ist der folgende:

 /**
 * test.c
 * Small Hello World! example
 * to compile with gcc, run the following command
 * gcc -o test test.c -lulfius
 */
#include 
#include 

#define PORT 8080

/**
 * Callback function for the web application on /helloworld url call
 */
int callback_hello_world ( const struct _u_request * request , struct _u_response * response , void * user_data ) {
  ulfius_set_string_body_response ( response , 200 , "Hello World!" );
  return U_CALLBACK_CONTINUE ;
}

/**
 * main function
 */
int main ( void ) {
  struct _u_instance instance ;

  // Initialize instance with the port number
  if ( ulfius_init_instance ( & instance , PORT , NULL , NULL ) != U_OK ) {
    fprintf ( stderr , "Error ulfius_init_instance, abortn" );
    return ( 1 );
  }

  // Endpoint list declaration
  ulfius_add_endpoint_by_val ( & instance , "GET" , "/helloworld" , NULL , 0 , & callback_hello_world , NULL );

  // Start the framework
  if ( ulfius_start_framework ( & instance ) == U_OK ) {
    printf ( "Start framework on port %dn" , instance . port );

    // Wait for the user to press  on the console to quit the application
    getchar ();
  } else {
    fprintf ( stderr , "Error starting frameworkn" );
  }
  printf ( "End frameworkn" );

  ulfius_stop_framework ( & instance );
  ulfius_clean_instance ( & instance );

  return 0 ;
}

Hauptmerkmale

Webservice

Erstellen Sie einen Webservice in einem separaten Thread. Der Endpunkt wird durch seine Methode (z. B. GET , POST , PUT , DELETE usw.) und seinen URL-Pfad mit seinen optionalen Parametern (z. B. /api/doc/@id ) identifiziert. Der Webservice wird in einer Callback-Funktion ausgeführt.
Streamen Sie große Datenmengen mit reduziertem Speicherbedarf.
Websocket-Dienst: Der Austausch von Websocket-Nachrichten wird in dedizierten Rückruffunktionen ausgeführt.

Kundenwünsche

Client-HTTP[s]- und SMTP-Anforderungen werden ausgeführt, die Antwort wird in einer dedizierten Struktur analysiert.
Ausführung der Client-Websocket-Anfrage, der Austausch von Websocket-Nachrichten wird in dedizierten Rückruffunktionen ausgeführt.

Websockets

Erstellen Sie eine WebSocket-Dienstanwendung
Erstellen Sie eine WebSocket-Clientanwendung
CLI zum Herstellen einer Verbindung zu einem Remote-Websocket: uwsc

Installation

Einzelheiten zur Installation finden Sie in der Datei INSTALL.md

Dokumentation

Einzelheiten zur API-Dokumentation finden Sie in der Datei API.md

Ein Doxygen-Format der API-Dokumentation finden Sie in der Online-Dokumentation.

Beispiel-Quellcode für Programme

Es stehen Beispielprogramme zur Verfügung, um die verschiedenen verfügbaren Funktionen zu verstehen. Detaillierte Beispielquellcodes und Dokumentation finden Sie im Ordner „example_programs“.

Beispiel-Callback-Funktionen

Beispiel-Callback-Funktionen sind im Ordner example_callbacks verfügbar. Die verfügbaren Beispiel-Rückruffunktionen sind:

Statischer Dateiserver: um statische Dateien eines bestimmten Ordners bereitzustellen
oauth2-Träger: um die Gültigkeit eines Oauth2-Träger-JWT-Tokens zu überprüfen. Erfordert libjwt.

Projekte, die das Ulfius-Framework verwenden

Glewlwyd, ein schlanker SSO-Server, der die Authentifizierungsprotokolle OAuth2 und OpenID Connect bereitstellt
Le Biniou, benutzerfreundliches und dennoch leistungsstarkes Musikvisualisierungs-/VJing-Tool
Angharad, Hausautomationssystem für ZWave und andere Gerätetypen
Hutch, ein sicherer Schließfach für Passwörter und andere Geheimnisse, der ausschließlich clientseitige JavaScript-Verschlüsselung verwendet
Taliesin, ein leichter Audio-Streaming-Server
Taulas Raspberry Pi Serielle Schnittstelle, eine Schnittstelle für Arduino-Geräte, die das Taulas-Protokoll implementieren, ein Hausautomatisierungsprotokoll für Angharad