remote-mailbox
TOC »
- remote-mailbox
- Documentation
- Common Parameters
- Client
- Server
- Usage
- remote-mailbox-default-listen
- remote-mailbox-default-auto-create?
- make-remote-mailbox-server
- make-remote-mailbox-server-thread
- remote-mailbox-server?
- remote-mailbox-server-name
- remote-mailbox-server-auto-create?
- remote-mailbox-server-listener
- remote-mailbox-server-request-limit
- remote-mailbox-server-debug
- remote-mailbox-server-run!
- remote-mailbox-server-start!
- remote-mailbox-server-stop!
- server-local-mailbox
- drop-server-local-mailbox!
- server-local-mailboxes
- Remote Mailbox Service
- Adapter
- Requirements
- Bugs and Limitations
- Author
- Version history
- License
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
remote-mailbox-default-tcp-port-no
- remote-mailbox-default-tcp-port-no #!optional TCP-PORT-NOparameter
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.
remote-mailbox-default-expected-size
- remote-mailbox-default-expected-size #!optional EXPECTEDparameter
The expected number of remote mailboxes, either as client or server.
- EXPECTED
- fixnum ; Defaults to 8.
Defaults to the environment variable REMOTE_MAILBOX_EXPECTED, or 8 if undefined at startup.
remote-mailbox-default-hostname
- remote-mailbox-default-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
(import remote-mailbox-client)
remote-mailbox-default-connect
- remote-mailbox-default-connect #!optional PROCEDUREparameter
The procedure used to establish network connections for a remote mailbox. Defaults to tcp-connect and must be signature-compatible.
remote-mailbox-default-hostname
- remote-mailbox-default-hostname REMOTE-MAILBOXparameter
Returns the REMOTE-MAILBOX hostname.
make-remote-mailbox
- (make-remote-mailbox NAME [#:hostname HOSTNAME] [#:tcp-port-no TCP-PORT-NO] [#:connect CONNECT]) -> remote-mailboxprocedure
Returns a unique remote-mailbox object for the specified NAME.
- NAME
- string ;
- HOSTNAME
- string ;. Defaults to (remote-mailbox-default-tcp-port-no).
- TCP-PORT-NO
- fixnum in [0 65535] or {{#f}} ; Defaults to (remote-mailbox-default-hostname).
- CONNECT
- procedure ; Defaults to (remote-mailbox-default-connect).
When TCP-PORT-NO 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-no
- remote-mailbox-tcp-port-no REMOTE-MAILBOXprocedure
Returns the REMOTE-MAILBOX tcp-port-no.
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
(import remote-mailbox-server)
remote-mailbox-default-listen
- remote-mailbox-default-listen #!optional PROCEDUREparameter
The procedure used to establish network connections for a remote mailbox. Defaults to tcp-listen and must be signature-compatible.
remote-mailbox-default-auto-create?
- remote-mailbox-default-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-no TCP-PORT-NO] [#: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
- symbol ; Defaults to rtmbsv#.
- TCP-PORT-NO
- fixnum in [0 65535] or {{#f}} ; Defaults to (remote-mailbox-default-tcp-port-no)
- LISTEN
- procedure ; Defaults to (remote-mailbox-default-listen)
- REQUEST-LIMIT
- fixnum ; The tcp-server upper limit for currently executing requests. Defaults to 10000.
- AUTO-CREATE?
- boolean ; Automatically create local-mailbox. Defaults to #t
- DEBUG
- (or false string) ; 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-listener
- remote-mailbox-server-listener REMOTE-MAILBOX-SERVERprocedure
Returns the listener object for the specified REMOTE-MAILBOX-SERVER.
remote-mailbox-server-request-limit
remote-mailbox-server-debug
remote-mailbox-server-run!
- remote-mailbox-server-run! REMOTE-MAILBOX-SERVERprocedure
Starts the server continuously processing remote mailbox sends until the connection is closed.
remote-mailbox-server-start!
- remote-mailbox-server-start! REMOTE-MAILBOX-SERVERprocedure
Starts the server in a thread continuously processing remote mailbox sends until the connection is closed.
Returns the started thread.
remote-mailbox-server-stop!
- remote-mailbox-server-stop! REMOTE-MAILBOX-SERVERprocedure
Closes the connection & stops the server thread.
server-local-mailbox
- server-local-mailbox 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! (server-local-mailbox REMOTE-MAILBOX-SERVER NAME))
drop-server-local-mailbox!
- drop-server-local-mailbox! REMOTE-MAILBOX-SERVER NAMEprocedure
Forget the server's mailbox.
server-local-mailboxes
- server-local-mailboxes REMOTE-MAILBOX-SERVERprocedure
Returns a list of all the mailboxes created for the server.
Remote Mailbox Service
A, singleton, convenience interface for remove-mailbox-server.
Usage
(import remote-mailbox-service)
remote-mailbox-service
- remote-mailbox-service NAME #!optional CREATE? DEBUGprocedure
This is a convenience interface and only recommended for the simplest of situations.
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.
The AUTO-CREATE? argument is passed on to server-local-mailbox.
To receive remote messages:
(mailbox-receive! (remote-mailbox-service NAME))
remote-mailbox-service-info
- remote-mailbox-service-infoprocedure
The remote-mailbox-server & thread for remote-mailbox-service.
remote-mailbox-service-stop!
- remote-mailbox-service-stop!procedure
The thread object for local-mailbox.
Adapter
Usage
(import 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 srfi-18 synch miscmacros moremacros condition-utils check-errors llrb-tree
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.
Author
Version history
- 1.0.6
- Better types & test.
- 1.0.5
- Better types & test.
- 1.0.4
- Use llrb-tree instead of srfi-69.
- 1.0.3
- Add remote-mailbox-service.
- 1.0.2
- Add remote-mailbox-default-expected-size.
- 1.0.1
- Clarify types.
- 1.0.0
- Initial Chicken 5 release.
License
Copyright (C) 2009-2022 Kon Lovett. All rights reserved.
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.