remote-mailbox

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

Documentation

Purports to provide an API for sending and receiving remote messages. This egg attempts to duplicate the mailbox egg semantics across an IP connection.

Common Parameters

default-remote-mailbox-tcp-port

default-remote-mailbox-tcp-port #!optional TCP-PORTparameter

The standard port number to establish a remote mailbox connection.

Defaults to the environment variable REMOTE-MAILBOX-TCP-PORT, or 63001 if undefined at startup.

default-remote-mailbox-hostname

default-remote-mailbox-hostname #!optional HOSTNAMEparameter

The host name to establish a remote mailbox connection.

Defaults to the environment variable REMOTE-MAILBOX-HOSTNAME, or "localhost" if undefined at startup.

Client

Usage

(require-extension remote-mailbox-client)

default-remote-mailbox-connect

default-remote-mailbox-connect #!optional PROCEDUREparameter: The procedure used to establish network connections for a remote mailbox. Defaults to tcp-connect and must be signature-compatible.

default-remote-mailbox-hostname

default-remote-mailbox-hostname REMOTE-MAILBOXparameter: Returns the REMOTE-MAILBOX hostname.

(remote-mailbox NAME [#:hostname HOSTNAME] [#:tcp-port TCP-PORT] [#:connect CONNECT]) -> remote-mailboxprocedure

Returns a unique remote-mailbox object for the specified NAME.

HOSTNAME: A string. Defaults to (default-remote-mailbox-tcp-port).
TCP-PORT: A fixnum in [0 65535] or #f. Defaults to (default-remote-mailbox-hostname).
CONNECT: A procedure. Defaults to (default-remote-mailbox-connect).

When TCP-PORT is #f the HOSTNAME must contain the port or service.

remote-mailbox?

remote-mailbox? OBJECTprocedure: Is the OBJECT a valid remote-mailbox?

remote-mailbox-name

remote-mailbox-name REMOTE-MAILBOXprocedure: Returns the REMOTE-MAILBOX name.

remote-mailbox-tcp-port

remote-mailbox-tcp-port REMOTE-MAILBOXprocedure: Returns the REMOTE-MAILBOX tcp-port.

remote-mailbox-connected?

remote-mailbox-connected? REMOTE-MAILBOXprocedure: Is the REMOTE-MAILBOX connected? (Has it been used?)

remote-mailboxes

remote-mailboxesprocedure: Returns mailboxes.

remote-mailbox-send!

remote-mailbox-send! REMOTE-MAILBOX OBJECTprocedure: Transmit the OBJECT to the REMOTE-MAILBOX.

drop-remote-mailbox!

drop-remote-mailbox! REMOTE-MAILBOXprocedure: Invalidate and forget the REMOTE-MAILBOX.

drop-remote-mailboxes!

drop-remote-mailboxes!procedure: Invalidate and forget all the remote mailboxes. Performs a reset to the initial state.

Server

Usage

(require-extension remote-mailbox-server)

default-remote-mailbox-listen

default-remote-mailbox-listen #!optional PROCEDUREparameter: The procedure used to establish network connections for a remote mailbox. Defaults to tcp-listen and must be signature-compatible.

default-remote-mailbox-auto-create?

default-remote-mailbox-auto-create? #!optional AUTO-CREATE?parameter: Automatically create local-mailbox? Defaults to #t.

make-remote-mailbox-server

(make-remote-mailbox-server [#:name NAME] [#:tcp-port TCP-PORT] [#:listen LISTEN] [#:request-limit REQUEST-LIMIT] [#:auto-create? AUTO-CREATE?] [#:debug DEBUG])procedure

Creates and returns a remote-mailbox-server. Uses 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.)

NAME: Defaults to remote-mailbox-server:#
TCP-PORT: Defaults to (default-remote-mailbox-tcp-port)
LISTEN: Defaults to (default-remote-mailbox-listen)
REQUEST-LIMIT: The tcp-server upper limit for currently executing requests. Defaults to 10000.
AUTO-CREATE?: Automatically create local-mailbox. Defaults to #t
DEBUG: Print tcp diagnostics with DEBUG prefix when true. Defaults to #f

make-remote-mailbox-server-thread

make-remote-mailbox-server-thread REMOTE-MAILBOX-SERVERprocedure: Returns a thread that, when started, will run the REMOTE-MAILBOX-SERVER.

remote-mailbox-server?

remote-mailbox-server? OBJECTprocedure: Is the OBJECT a remote-mailbox-server?

remote-mailbox-server-name

remote-mailbox-server-name REMOTE-MAILBOX-SERVERprocedure: Returns the name of the specified REMOTE-MAILBOX-SERVER.

remote-mailbox-server-auto-create?

remote-mailbox-server-auto-create? REMOTE-MAILBOX-SERVERprocedure

remote-mailbox-server-listener

remote-mailbox-server-listener REMOTE-MAILBOX-SERVERprocedure: Returns the listener object for the specified REMOTE-MAILBOX-SERVER.

Starts the server in a thread continuously processing remote mailbox sends until the connection is closed.

Returns the started thread.

remote-mailbox-server-run!

remote-mailbox-server-run! REMOTE-MAILBOX-SERVERprocedure: Starts the server continuously processing remote mailbox sends until the connection is closed.

local-mailbox-for-server

local-mailbox-for-server REMOTE-MAILBOX-SERVER NAMEprocedure

Returns the mailbox of NAME for REMOTE-MAILBOX-SERVER (a mailbox object as returned by the procedure make-mailbox). Should the mailbox not exist it will be created if the REMOTE-MAILBOX-SERVER has a true AUTO-CREATE? flag, otherwise returns #f.

To receive remote messages:

(mailbox-receive! (local-mailbox-for-server REMOTE-MAILBOX-SERVER NAME))

drop-local-mailbox!-for-server

drop-local-mailbox!-for-server REMOTE-MAILBOX-SERVER NAMEprocedure: Forget the server's mailbox.

local-mailbox-names-for-server

local-mailbox-names-for-server REMOTE-MAILBOX-SERVERprocedure: Returns a list of all the names of the mailboxes created for the server.

local-mailbox

local-mailbox NAME #!optional DEBUGprocedure

This is a convenience interface and only recommended for the simplest of situations.

When NAME is:

default-remote-mailbox-server-thread: returns the thread for the default server.
default-remote-mailbox-server: returns the default server record.
<other symbol>: returns the mailbox for NAME.

The DEBUG argument is passed on to tcp-server which will print tcp diagnostics with DEBUG as a prefix. The other parameters to make-remote-mailbox-server are defaulted.

The default server is created and run in a separate thread upon the first call.

To receive remote messages:

(mailbox-receive! (local-mailbox NAME))

local-mailbox-start!

local-mailbox-start! #!optional DEBUGprocedure: What local-mailbox does upon the first invocation.

local-mailbox-server

local-mailbox-serverprocedure: The remote-mailbox-server object for local-mailbox.

local-mailbox-thread

local-mailbox-threadprocedure: The thread object for local-mailbox.

Adapter

Usage

(require-extension remote-mailbox-adapter)

serializer

serializer #!optional PROCEDUREparameter: Parameter for Scheme object serialization procedure. Default is s11n::serialize.

deserializer

deserializer #!optional PROCEDUREparameter: Parameter for Scheme object deserialization procedure. Default is s11n::deserialize.

deserializer-input

deserializer-input #!optional INPUT-PORTparameter: Parameter for deserialization procedure input. Default is (current-input-port).

serializer-output

serializer-output #!optional OUTPUT-PORTparameter: Parameter for serialization procedure output. Default is (current-output-port).

serialize

serialize OBJECT #!optional OUTPUT-PORT serializer-outputprocedure: Serialize the OBJECT to the OUTPUT-PORT.

deserialize

deserialize #!optional INPUT-PORT deserializer-inputprocedure: Deserialize the OBJECT from the INPUT-PORT.

Requirements

tcp-server s11n mailbox miscmacros moremacros synch lookup-table type-errors

setup-helper

Bugs and Limitations

The sender (client) identity is not part of this API.
"Curry" to supply BACKLOG and/or HOST arguments to the listen procedure.
There is not a good way to terminate a tcp-server. The test terminates the thread and then joins under an exception handler. Ugh.

Author

Kon Lovett

Version history

2.2.0: Add types. Add local-mailbox-for-server, drop-local-mailbox!-for-server, local-mailbox-names-for-server.
2.1.2
2.1.1
2.1.0: Add remote-mailbox-adapter. Remove default-remote-mailbox-serializer, default-remote-mailbox-deserializer, & associated parameters.
2.0.1: Explicit requirements.
2.0.0: Initial Chicken 4 release.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

chickadee » remote-mailbox

Identifier search

TOC »

Contents »