url-scgi
- Description
- SCGI support for url.el
- Latest
- url-scgi-0.9.0.20231222.161107.tar (.sig), 2024-Mar-31, 30.0 KiB
- Maintainer
- Stefan Kangas <stefankangas@gmail.com>
- Atom feed
- url-scgi.xml
- Website
- https://github.com/skangas/url-scgi/
- Browse ELPA's repository
- CGit or Gitweb
- Badge
To install this package from Emacs, use package-install
or list-packages
.
Full description
This library adds support for Simple Common Gateway Interface (SCGI) URLs to the
built-in Emacs url
library.
The SCGI protocol is intended as a replacement for the older CGI protocol, and is comparable to FastCGI or WAI, but much simpler. Thus, the SCGI protocol is most often used by web servers to communicate with a program that serves dynamically generated pages and files (instead of just static ones). SCGI is supported in web servers such as Apache, lighttpd, and nginx.
This library effectively makes Emacs take the place of a web server. This can
be useful for testing, but not only that. It was originally developed for
Mentor, an Emacs front-end for the BitTorrent client rtorrent
, where it is
used for remote procedure calls (RPC).
SCGI is described in more detail on Wikipedia. As far as I know, there is no RFC describing SCGI, nor is there any formal specification. On the other hand, the protocol is very simple; it is described in detail here.
SCGI URLs look like this: scgi://<host>:<port>
. See below for an example.
1. Installation
url-scgi.el can be installed from GNU ELPA, an Emacs Lisp package archive that is enabled by default in Emacs.
Find and install url-sgi.el using this command:
M-x list-packages
1.1. Usage
First, require url-scgi
:
(require 'url-scgi)
Now, to make an SCGI request with url-scgi
, simply call url-retrieve
or
url-retrieve-synchronously
with a URL starting with scgi://
.
For example, let's assume you have some program listening for SCGI requests on
localhost
port 5000
. You can then issue a request containing the string
some-data
with:
(url-retrieve-synchronously "scgi://localhost:5000/some-data")
You will want to replace some-data
with something relevant to the program you
are talking to. Please refer to its documentation for details.
If your application supports XML-RPC (remote procedure calls) over SCGI, you can
make such calls using url-scgi
with the xml-rpc
package. For example, if
your program supports an XML-RPC method named foo
, you would call it like
so:
(require 'url-scgi) (require 'xml-rpc) (xml-rpc-method-call "scgi://localhost:5000" "foo")
For more, see the documentation of the xml-rpc
package.
1.2. Contribute
This library is part of GNU ELPA and therefore requires a copyright assignment to the Free Software Foundation for any non-trivial contributions.
Please email me a patch, or open a pull request on GitHub, according to your preferences.
1.3. Contact
You can find the latest version of url-scgi.el here:
https://www.github.com/skangas/url-scgi
Bug reports, comments, and suggestions are welcome! Email them to Stefan Kangas <stefankangas@gmail.com> or report them on GitHub.
Old versions
url-scgi-0.9.0.20231009.93301.tar.lz | 2023-Oct-09 | 6.33 KiB |
url-scgi-0.9.0.20230905.134155.tar.lz | 2023-Sep-05 | 6.33 KiB |
url-scgi-0.9.0.20230130.74744.tar.lz | 2023-Jan-30 | 6.32 KiB |
url-scgi-0.8.0.20230103.114212.tar.lz | 2023-Jan-03 | 6.30 KiB |
url-scgi-0.8.0.20221224.42354.tar.lz | 2022-Dec-24 | 6.31 KiB |
url-scgi-0.8.0.20221206.172827.tar.lz | 2022-Dec-06 | 5.43 KiB |
url-scgi-0.8.0.20221118.114308.tar.lz | 2022-Nov-18 | 5.43 KiB |
url-scgi-0.8.0.20221115.95131.tar.lz | 2022-Nov-15 | 5.43 KiB |
url-scgi-0.8.0.20221030.145856.tar.lz | 2022-Oct-30 | 5.20 KiB |
url-scgi-0.7.0.20221029.5846.tar.lz | 2022-Oct-29 | 4.86 KiB |