Updated 2016-09-01 21:07:25 by droll

T2WS - Tiny Tcl Web Server edit

T2WS is a small HTTP server that is easily deployable and embeddable in Tcl applications.

T2WS has the following features :

  • Easy to use - A few lines are sufficient to build a file server or to embed a web server into an application (see example below)
  • Fast - About 90 responses per second on a Raspberry PI version 1
  • Multi-port support - Can handle simultaneously multiple sites or ports
  • Expandable - A plugin interface allows expanding the T2WS feature set
  • Template engine - A template engine is available via a plugin
  • SSL/TLS support - Secure connections are supported via the TLS package

To add a T2WS web server to a Tcl application, load the T2WS package, create an application specific web server responder command and start the HTTP server for the desired port (e.g. 8085) :
package require t2ws

proc MyResponder {Request} {
   # Process the request URI: Extract a command and its arguments
   regexp {^/(\w*)/(.*)$} [dict get $Request URI] {} Command Arguments
   # Implement the different commands (eval <TclCommand>, file <File>)
   switch -exact -- $Command {
      "eval" {
         set Data [uplevel #0 $Arguments]
         return [dict create Body $Data Content-Type "text/plain"] }
      "file" {
         return [dict create File $Arguments] }
   # Return the status 404 (not found) if the command is unknown
   return [dict create Status "404"]

t2ws::Start 8085 -responder ::MyResponder

With this responder command example the web server will accept the commands eval and file and return an error for other requests :
http://localhost:8085/eval/glob *.tcl
-> pkgIndex.tcl t2ws.tcl t2ws_template.tcl

-> if {![package vsatisfies [package provide Tcl] 8.5]} {return} ...

-> 404 Not Found

Multiple responder commands can be defined for different purposes. The following example is equivalent to the previous one, but it uses separate responder commands for the command evaluation and for the file access :
package require t2ws

proc MyResponder_Eval {Request} {
   set Data [uplevel #0 [dict get $Request URITail]]
   return [dict create Body $Data Content-Type "text/plain"]

proc MyResponder_File {Request} {
   return [dict create File [dict get $Request URITail]]

set Port [t2ws::Start 8085]
t2ws::DefineRoute $Port ::MyResponder_Eval -method GET -uri "/eval/*"
t2ws::DefineRoute $Port ::MyResponder_File -method GET -uri "/file/*"

See also edit

APN This is looking very promising. I would add "Well documented" to your features list! Any chance you are planning to add support for basic authentication?

[ADr] Currently there is an ongoing development of a new T2WS plugin that provides cookie-based authentication and session management. No plugin for basic authentication is currently planned, but this may change if there is a broad request for that.