waldek
/
jetforce
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Michael Lazar 2020-05-15 01:22:34 -04:00
parent b5acfb594b
commit 36e29f5d15
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
jetforce.py
View File

@ -6,11 +6,12 @@ Overview
-------- --------
GeminiServer: GeminiServer:
An asynchronous TCP server built on top of python's asyncio stream A TCP + TLS server build on top of the python twisted framework. This class
abstraction. This is a lightweight class that accepts incoming requests, is responsible for binding to the TCP/IP interface, setting up the TLS
logs them, and sends them to a configurable request handler to be processed. context, handling incoming connections, and sending connections to to a
request handler to be processed.
GeminiRequestHandler: GeminiProtocol:
The request handler manages the life of a single gemini request. It exposes The request handler manages the life of a single gemini request. It exposes
a simplified interface to read the request URL and write the gemini response a simplified interface to read the request URL and write the gemini response
status line and body to the socket. The request URL and other server status line and body to the socket. The request URL and other server
@ -27,10 +28,10 @@ JetforceApplication:
how to accomplish this. how to accomplish this.
StaticDirectoryApplication: StaticDirectoryApplication:
This is a pre-built application that serves files from a static directory. This is a batteries-included application that serves files from a static
It provides an "out-of-the-box" gemini server without needing to write any directory. It provides a preconfigured gemini server without needing to
lines of code. This is what is invoked when you launch jetforce from the write any lines of code. This is what is invoked when you launch jetforce
command line. from the command line.
""" """
from __future__ import annotations from __future__ import annotations
@ -290,10 +291,10 @@ class StaticDirectoryApplication(JetforceApplication):
""" """
Application for serving static files & CGI over gemini. Application for serving static files & CGI over gemini.
This is a pre-built application that serves files from a static directory. This is a batteries-included application that serves files from a static
It provides an "out-of-the-box" gemini server without needing to write any directory. It provides a preconfigured gemini server without needing to
lines of code. This is what is invoked when you launch jetforce from the write any lines of code. This is what is invoked when you launch jetforce
command line. from the command line.
If a directory contains a file with the name "index.gmi", that file will If a directory contains a file with the name "index.gmi", that file will
be returned when the directory path is requested. Otherwise, a directory be returned when the directory path is requested. Otherwise, a directory