actors: Document the <message> records's fields.
authorChristopher Allan Webber <cwebber@dustycloud.org>
Tue, 20 Dec 2016 21:28:10 +0000 (15:28 -0600)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Tue, 20 Dec 2016 21:28:10 +0000 (15:28 -0600)
* 8sync/actors.scm (<message>): Add comments.

8sync/actors.scm

index fdcbc85193c43300b293de7e8abb92933073810d..c694c489992abd9a99a9aca57f2afc605103e822 100644 (file)
                        body in-reply-to wants-reply
                        replied)
   message?
-  (id message-id)
-  (to message-to)
-  (from message-from)
-  (action message-action)
-  (body message-body)
-  (in-reply-to message-in-reply-to)
-  (wants-reply message-wants-reply)
-  (replied message-replied set-message-replied!))
+  (id message-id)                    ; id of this message
+  (to message-to)                    ; actor id this is going to
+  (from message-from)                ; actor id of sender
+  (action message-action)            ; action (a symbol) to be handled
+  (body message-body)                ; argument list "body" of message
+  (in-reply-to message-in-reply-to)  ; message id this is in reply to, if any
+  (wants-reply message-wants-reply)  ; whether caller is waiting for reply
+  (replied message-replied           ; was this message replied to?
+           set-message-replied!))
 
 
 (define* (make-message id to from action body