doc/8sync.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename 8sync.info
   4 @settitle 8sync
   5 @c %**end of header
   6 @copying
   7 Copyright @copyright{} 2015  Christopher Allan Webber @email{cwebber@@dustycloud.org}
   8 @end copying
   9
  10 @quotation
  11 Permission is granted to copy, distribute and/or modify this document
  12 under the terms of the GNU Free Documentation License, Version 1.3
  13 or any later version published by the Free Software Foundation;
  14 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
  15 A copy of the license is included in the section entitled ``GNU
  16 Free Documentation License''.
  17
  18 A copy of the license is also available from the Free Software
  19 Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
  20
  21 Altenately, this document is also available under the Lesser General
  22 Public License, version 3 or later, as published by the Free Software
  23 Foundation.
  24
  25 A copy of the license is also available from the Free Software
  26 Foundation Web site at @url{http://www.gnu.org/licenses/lgpl.html}.
  27
  28 @end quotation
  29
  30
  31 @titlepage
  32 @title 8sync 0.1
  33 @subtitle Using 8sync, an asynchronous event loop for Guile
  34 @author Christopher Allan Webber
  35 @page
  36 @vskip 0pt plus 1filll
  37 @insertcopying
  38 @end titlepage
  39
  40 @c Output the table of the contents at the beginning.
  41 @contents
  42
  43 @ifnottex
  44 @node Top
  45 @top 8sync
  46
  47 @insertcopying
  48 @end ifnottex
  49
  50 @c Generate the nodes for this menu with `C-c C-u C-m'.
  51
  52
  53 @c Update all node entries with `C-c C-u C-n'.
  54 @c Insert new nodes with `C-c C-c n'.
  55
  56 @menu
  57 * Introduction::
  58 * Acknowledgements::
  59 * 8sync's license and general comments on copyleft::
  60 * Copying This Manual::
  61 * Index::
  62 @end menu
  63
  64 @node Introduction
  65 @chapter Introduction
  66
  67 8sync's goal is to make asynchronous programming easy.
  68 If you've worked with most other asynchronous programming environments,
  69   you know that it generally isn't.
  70 Usually asynchronous programming involves entering some sort of
  71   ``callback hell''.
  72 Some nicer environments like Asyncio for Python provide generator-based
  73   coroutines, but even these require a lot of work to carefully line up.
  74
  75 Coding in 8sync, on the other hand, looks almost entirely like coding
  76   anywhere else.
  77 This is because 8sync makes great use of a cool feature in Guile called
  78   ``delimited continuations'' to power natural-feeling coroutines.
  79 Because of this, you can invoke your asynchronous code with a small wrapper
  80   around it, and that code will pop off to complete whatever other task it
  81   needs to do, and resume your function when it's ready passing back the
  82   appropriate value.
  83 (No need to manually chain the coroutines together, and no callback hell at
  84   all!)
  85
  86 Now that's pretty cool!
  87
  88 @node Acknowledgements
  89 @chapter Acknowledgements
  90
  91 8sync has a number of inspirations:
  92
  93 @itemize @bullet
  94 @item
  95 @uref{https://docs.python.org/3.5/library/asyncio.html, asyncio}
  96   for Python provides a nice asynchronous programming environment, and
  97   makes great use of generator-style coroutines.
  98 It's a bit more difficult to work with than 8sync (or so thinks the author)
  99   because you have to ``line up'' the coroutines.
 100
 101 @item
 102 @uref{http://dthompson.us/pages/software/sly.html, Sly}
 103   by David Thompson is an awesome functional reactive game programming
 104   library for Guile.
 105 If you want to write graphical games, Sly is almost certainly a better choice
 106   than 8sync.
 107 Thanks to David for being very patient in explaining tough concepts;
 108   experience on hacking Sly greatly informed 8sync's development.
 109 (Check out Sly, it rocks!)
 110
 111 @item
 112 Reading @uref{https://mitpress.mit.edu/sicp/, SICP}, particularly
 113   @uref{https://mitpress.mit.edu/sicp/full-text/book/book-Z-H-19.html#%_chap_3,
 114         Chapter 3's writings on concurrent systems},
 115   greatly informed 8sync's design.
 116
 117 @item
 118 Finally, @uref{https://docs.python.org/3.5/library/asyncio.html, XUDD}
 119   was an earlier ``research project'' that preceeded 8sync.
 120 It attempted to bring an actor model system to Python.
 121 However, the author eventually grew frustrated with some of Python's
 122   limitations, fell in love with Guile, and well... now we have 8sync, which
 123   is much more general anyway.
 124
 125 @end itemize
 126
 127 The motivation to build 8sync came out of
 128   @uref{https://lists.gnu.org/archive/html/guile-devel/2015-10/msg00015.html,
 129         a conversation}
 130   at the FSF 30th party between Mark Weaver, David Thompson, Andrew
 131   Engelbrecht, and Christopher Allan Webber over how to build
 132   an asynchronous event loop for Guile and just what would be needed.
 133
 134 A little over a month after that, hacking on 8sync began!
 135
 136
 137 @node 8sync's license and general comments on copyleft
 138 @chapter 8sync's license and general comments on copyleft
 139
 140 8sync is released under the GNU LGPL (Lesser General Public License),
 141   version 3 or later, as published by the Free Software Foundation.
 142 The short version of this is that if you distribute a modifications to
 143   8sync, whether alone or in some larger combination, must release the
 144   corresponding source code.
 145 A program which uses this library, if distributed without source code,
 146   must also allow relinking with a modified version of this library.
 147 In general, it is best to contribute them back to 8sync under the same terms;
 148   we'd appreciate any enhancements or fixes to be contributed upstream to
 149   8sync itself.
 150 (This is an intentional oversimplification for brevity, please read the LGPL
 151   for the precise terms.)
 152
 153 This usage of the LGPL helps us ensure that 8sync and derivatives of
 154   8sync as a library will remain free.
 155 Though it is not a requirement, we request you use 8sync to build free
 156   software rather than use it to contribute to the growing world of
 157   proprietary software.
 158
 159 The choice of the LGPL for 8sync was a strategic one.
 160 This is not a general recommendation to use the LGPL instead of the GPL
 161   for all libraries.
 162 In general, we encourage stronger copyleft.
 163 (For more thinking on this position, see
 164   @uref{https://www.gnu.org/licenses/why-not-lgpl.html,
 165         Why you shouldn't use the Lesser GPL for your next library}.)
 166
 167 Although 8sync provides some unique features, its main functionality is as
 168   an asynchronous event loop, and there are many other asynchronous event
 169   loop systems out there such as Node.js for Javascript and Asyncio for
 170   Python (there are others as well).
 171 It is popular in some of these communities to hold anti-copyleft positions,
 172   which is unfortunate, and many community members seem to be adopting
 173   these positions because other developers they look up to are holding
 174   them.
 175 If you have come from one of these communities and are exploring 8sync, we
 176   hope reading this will help you reconsider your position.
 177
 178 In particular, if you are building a library or application that uses
 179   8sync in some useful way, consider releasing your program under the GNU
 180   GPL or GNU AGPL!
 181 In a world where more and more software is locked down, where software is used
 182   to restrict users, we could use every chance we can get to provide
 183   protections so that software which is free remains free, and encourages even
 184   more software freedom to be built upon it.
 185
 186 So to answer the question, ``Can I build a proprietary program on top of
 187   8sync?'' our response is
 188   ``Yes, but please don't.
 189     Choose to release your software under a freedom-respecting license.
 190     And help us turn the tide towards greater software freedom...
 191       consider a strong copyleft license!''
 192
 193
 194 @node Copying This Manual
 195 @appendix Copying This Manual
 196
 197 This manual is licensed under the GNU Free Documentation License, with
 198 no invariant sections.  At your option, it is also available under the
 199 GNU Lesser General Public License, as published by the Free Software
 200 Foundation, version 3 or any later version.
 201
 202 @menu
 203 * GNU Free Documentation License::  License for copying this manual.
 204 @end menu
 205
 206 @c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
 207 @node GNU Free Documentation License
 208 @section GNU Free Documentation License
 209 @include fdl.texi
 210
 211 @node Index
 212 @unnumbered Index
 213
 214 @syncodeindex tp fn
 215 @syncodeindex vr fn
 216 @printindex fn
 217
 218 @bye
 219
 220 @c 8sync.texi ends here