(index ("default-remote-mailbox-tcp-port" 0) ("default-remote-mailbox-hostname" 315) ("default-remote-mailbox-connect" 627) ("default-remote-mailbox-hostname" 896) ("remote-mailbox" 1062) ("remote-mailbox?" 1733) ("remote-mailbox-name" 1871) ("remote-mailbox-tcp-port" 2009) ("remote-mailbox-connected?" 2159) ("remote-mailboxes" 2329) ("remote-mailbox-send!" 2449) ("drop-remote-mailbox!" 2617) ("drop-remote-mailboxes!" 2766) ("default-remote-mailbox-listen" 2938) ("default-remote-mailbox-auto-create?" 3204) ("make-remote-mailbox-server" 3404) ("make-remote-mailbox-server-thread" 4432) ("remote-mailbox-server?" 4655) ("remote-mailbox-server-name" 4819) ("remote-mailbox-server-auto-create?" 5012) ("remote-mailbox-server-listener" 5148) ("remote-mailbox-server-request-limit" 5364) ("remote-mailbox-server-debug" 5501) ("remote-mailbox-server-start!" 5612) ("remote-mailbox-server-run!" 5872) ("local-mailbox-for-server" 6082) ("drop-local-mailbox!-for-server" 6638) ("local-mailbox-names-for-server" 6795) ("local-mailbox" 6991) ("local-mailbox-start!" 7825) ("local-mailbox-server" 7976) ("local-mailbox-thread" 8156) ("serializer" 8306) ("deserializer" 8484) ("deserializer-input" 8670) ("serializer-output" 8865) ("serialize" 9060) ("deserialize" 9223))
(def (sig (parameter "(default-remote-mailbox-tcp-port [TCP-PORT]) -> fixnum" (id default-remote-mailbox-tcp-port))) (p "The standard port number to establish a remote mailbox connection.") (p "Defaults to the environment variable " (tt "REMOTE-MAILBOX-TCP-PORT") ", or " (tt "63001") " if undefined at startup."))
(def (sig (parameter "(default-remote-mailbox-hostname [HOSTNAME]) -> string" (id default-remote-mailbox-hostname))) (p "The host name to establish a remote mailbox connection.") (p "Defaults to the environment variable " (tt "REMOTE-MAILBOX-HOSTNAME") ", or " (tt "\"localhost\"") " if undefined at startup."))
(def (sig (parameter "(default-remote-mailbox-connect [PROCEDURE]) -> procedure" (id default-remote-mailbox-connect))) (p "The procedure used to establish network connections for a remote mailbox. Defaults to " (tt "tcp-connect") " and must be signature-compatible."))
(def (sig (parameter "(default-remote-mailbox-hostname REMOTE-MAILBOX)" (id default-remote-mailbox-hostname))) (p "Returns the " (tt "REMOTE-MAILBOX") " hostname."))
(def (sig (procedure "(remote-mailbox NAME [#:hostname HOSTNAME] [#:tcp-port TCP-PORT] [#:connect CONNECT]) -> remote-mailbox" (id remote-mailbox))) (p "Returns a unique " (tt "remote-mailbox") " object for the specified " (tt "NAME") ".") (dl (dt (tt "HOSTNAME")) (dd "A string. Defaults to " (tt "(default-remote-mailbox-tcp-port)") ".") (dt (tt "TCP-PORT")) (dd "A fixnum in [0 65535] or " (tt "#f") ". Defaults to " (tt "(default-remote-mailbox-hostname)") ".") (dt (tt "CONNECT")) (dd "A procedure. Defaults to " (tt "(default-remote-mailbox-connect)") ".")) (p "When " (tt "TCP-PORT") " is " (tt "#f") " the " (tt "HOSTNAME") " must contain the port or service."))
(def (sig (procedure "(remote-mailbox? OBJECT)" (id remote-mailbox?))) (p "Is the " (tt "OBJECT") " a valid " (tt "remote-mailbox") "?"))
(def (sig (procedure "(remote-mailbox-name REMOTE-MAILBOX)" (id remote-mailbox-name))) (p "Returns the " (tt "REMOTE-MAILBOX") " name."))
(def (sig (procedure "(remote-mailbox-tcp-port REMOTE-MAILBOX)" (id remote-mailbox-tcp-port))) (p "Returns the " (tt "REMOTE-MAILBOX") " tcp-port."))
(def (sig (procedure "(remote-mailbox-connected? REMOTE-MAILBOX)" (id remote-mailbox-connected?))) (p "Is the " (tt "REMOTE-MAILBOX") " connected? (Has it been used?)"))
(def (sig (procedure "(remote-mailboxes) -> (list-of remote-mailbox)" (id remote-mailboxes))) (p "Returns mailboxes."))
(def (sig (procedure "(remote-mailbox-send! REMOTE-MAILBOX OBJECT)" (id remote-mailbox-send!))) (p "Transmit the " (tt "OBJECT") " to the " (tt "REMOTE-MAILBOX") "."))
(def (sig (procedure "(drop-remote-mailbox! REMOTE-MAILBOX)" (id drop-remote-mailbox!))) (p "Invalidate and forget the " (tt "REMOTE-MAILBOX") "."))
(def (sig (procedure "(drop-remote-mailboxes!)" (id drop-remote-mailboxes!))) (p "Invalidate and forget all the remote mailboxes. Performs a reset to the initial state."))
(def (sig (parameter "(default-remote-mailbox-listen [PROCEDURE]) -> procedure" (id default-remote-mailbox-listen))) (p "The procedure used to establish network connections for a remote mailbox. Defaults to " (tt "tcp-listen") " and must be signature-compatible."))
(def (sig (parameter "(default-remote-mailbox-auto-create? [AUTO-CREATE?]) -> boolean" (id default-remote-mailbox-auto-create?))) (p "Automatically create local-mailbox? Defaults to " (tt "#t") "."))
(def (sig (procedure "(make-remote-mailbox-server [#:name NAME] [#:tcp-port TCP-PORT] [#:listen LISTEN] [#:request-limit REQUEST-LIMIT] [#:auto-create? AUTO-CREATE?] [#:debug DEBUG])" (id make-remote-mailbox-server))) (p "Creates and returns a " (tt "remote-mailbox-server") ". Uses " (tt "make-tcp-server") " to create a server procedure. The server threads spawned by this procedure are continuously processing remote mailbox sends until the connection is closed.)") (dl (dt (tt "NAME")) (dd "Defaults to " (tt "remote-mailbox-server:#")) (dt (tt "TCP-PORT")) (dd "Defaults to " (tt "(default-remote-mailbox-tcp-port)")) (dt (tt "LISTEN")) (dd "Defaults to " (tt "(default-remote-mailbox-listen)")) (dt (tt "REQUEST-LIMIT")) (dd "The tcp-server upper limit for currently executing requests. Defaults to " (tt "10000") ".") (dt (tt "AUTO-CREATE?")) (dd "Automatically create local-mailbox. Defaults to " (tt "#t")) (dt (tt "DEBUG")) (dd "Print tcp diagnostics with " (tt "DEBUG") " prefix when true. Defaults to " (tt "#f"))))
(def (sig (procedure "(make-remote-mailbox-server-thread REMOTE-MAILBOX-SERVER) -> thread" (id make-remote-mailbox-server-thread))) (p "Returns a thread that, when started, will run the " (tt "REMOTE-MAILBOX-SERVER") "."))
(def (sig (procedure "(remote-mailbox-server? OBJECT) -> boolean" (id remote-mailbox-server?))) (p "Is the " (tt "OBJECT") " a " (tt "remote-mailbox-server") "?"))
(def (sig (procedure "(remote-mailbox-server-name REMOTE-MAILBOX-SERVER) -> string" (id remote-mailbox-server-name))) (p "Returns the name of the specified " (tt "REMOTE-MAILBOX-SERVER") "."))
(def (sig (procedure "(remote-mailbox-server-auto-create? REMOTE-MAILBOX-SERVER) -> boolean" (id remote-mailbox-server-auto-create?))))
(def (sig (procedure "(remote-mailbox-server-listener REMOTE-MAILBOX-SERVER) -> procedure" (id remote-mailbox-server-listener))) (p "Returns the listener object for the specified " (tt "REMOTE-MAILBOX-SERVER") "."))
(def (sig (procedure "(remote-mailbox-server-request-limit REMOTE-MAILBOX-SERVER) -> fixnum" (id remote-mailbox-server-request-limit))))
(def (sig (procedure "(remote-mailbox-server-debug REMOTE-MAILBOX-SERVER)" (id remote-mailbox-server-debug))))
(def (sig (procedure "(remote-mailbox-server-start! REMOTE-MAILBOX-SERVER)" (id remote-mailbox-server-start!))) (p "Starts the server in a thread continuously processing remote mailbox sends until the connection is closed.") (p "Returns the started thread."))
(def (sig (procedure "(remote-mailbox-server-run! REMOTE-MAILBOX-SERVER)" (id remote-mailbox-server-run!))) (p "Starts the server continuously processing remote mailbox sends until the connection is closed."))
(def (sig (procedure "(local-mailbox-for-server REMOTE-MAILBOX-SERVER NAME) -> mailbox" (id local-mailbox-for-server))) (p "Returns the mailbox of " (tt "NAME") " for " (tt "REMOTE-MAILBOX-SERVER") " (a mailbox object as returned by the procedure " (tt "make-mailbox") "). Should the mailbox not exist it will be created if the " (tt "REMOTE-MAILBOX-SERVER") " has a true " (tt "AUTO-CREATE?") " flag, otherwise returns " (tt "#f") ".") (p "To receive remote messages:") (p (tt "(mailbox-receive! (local-mailbox-for-server REMOTE-MAILBOX-SERVER NAME))")))
(def (sig (procedure "(drop-local-mailbox!-for-server REMOTE-MAILBOX-SERVER NAME)" (id drop-local-mailbox!-for-server))) (p "Forget the server's mailbox."))
(def (sig (procedure "(local-mailbox-names-for-server REMOTE-MAILBOX-SERVER)" (id local-mailbox-names-for-server))) (p "Returns a list of all the names of the mailboxes created for the server."))
(def (sig (procedure "(local-mailbox NAME [DEBUG])" (id local-mailbox))) (p "This is a convenience interface and only recommended for the simplest of situations.") (p "When " (tt "NAME") " is:") (dl (dt "default-remote-mailbox-server-thread") (dd "returns the thread for the default server.") (dt "default-remote-mailbox-server") (dd "returns the default server record.") (dt "<other symbol>") (dd "returns the mailbox for " (tt "NAME") ".")) (p "The " (tt "DEBUG") " argument is passed on to " (tt "tcp-server") " which will print tcp diagnostics with " (tt "DEBUG") " as a prefix. The other parameters to " (tt "make-remote-mailbox-server") " are defaulted.") (p "The default server is created and run in a separate thread upon the first call.") (p "To receive remote messages:") (p (tt "(mailbox-receive! (local-mailbox NAME))")))
(def (sig (procedure "(local-mailbox-start! [DEBUG])" (id local-mailbox-start!))) (p "What " (tt "local-mailbox") " does upon the first invocation."))
(def (sig (procedure "(local-mailbox-server) -> remote-mailbox-server" (id local-mailbox-server))) (p "The " (tt "remote-mailbox-server") " object for " (tt "local-mailbox") "."))
(def (sig (procedure "(local-mailbox-thread) -> thread" (id local-mailbox-thread))) (p "The " (tt "thread") " object for " (tt "local-mailbox") "."))
(def (sig (parameter "(serializer [PROCEDURE]) -> procedure" (id serializer))) (p "Parameter for Scheme object serialization procedure. Default is " (tt "s11n::serialize") "."))
(def (sig (parameter "(deserializer [PROCEDURE]) -> procedure" (id deserializer))) (p "Parameter for Scheme object deserialization procedure. Default is " (tt "s11n::deserialize") "."))
(def (sig (parameter "(deserializer-input [INPUT-PORT]) -> input-port" (id deserializer-input))) (p "Parameter for deserialization procedure input. Default is " (tt "(current-input-port)") "."))
(def (sig (parameter "(serializer-output [OUTPUT-PORT]) -> output-port" (id serializer-output))) (p "Parameter for serialization procedure output. Default is " (tt "(current-output-port)") "."))
(def (sig (procedure "(serialize OBJECT [OUTPUT-PORT (serializer-output)])" (id serialize))) (p "Serialize the " (tt "OBJECT") " to the " (tt "OUTPUT-PORT") "."))
(def (sig (procedure "(deserialize [INPUT-PORT (deserializer-input)]) -> *" (id deserialize))) (p "Deserialize the " (tt "OBJECT") " from the " (tt "INPUT-PORT") "."))
