Changeset 35331 in project


Ignore:
Timestamp:
03/24/18 20:59:06 (4 months ago)
Author:
kon
Message:

rel 2.2.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/remote-mailbox

    r34488 r35331  
    1515==== default-remote-mailbox-tcp-port
    1616
    17 <procedure>(default-remote-mailbox-tcp-port [TCP-PORT])</procedure>
    18 
    19 The standard port number to establish a remote mailbox connection. Defaults to
    20 {{63001}}.
     17<parameter>(default-remote-mailbox-tcp-port [TCP-PORT]) -> fixnum</parameter>
     18
     19The standard port number to establish a remote mailbox connection.
     20
     21Defaults to the environment variable {{REMOTE-MAILBOX-TCP-PORT}}, or {{63001}}
     22if undefined at startup.
    2123
    2224==== default-remote-mailbox-hostname
    2325
    24 <procedure>(default-remote-mailbox-hostname [HOST-NHAME])</procedure>
    25 
    26 The host name to establish a remote mailbox connection. Defaults to
    27 {{"localhost"}}.
    28 
    29 ==== serializer
    30 
    31 <procedure>(default-remote-mailbox-hostname [HOST-NHAME])</procedure>
    32 
    33 The host name to establish a remote mailbox connection. Defaults to
    34 {{"localhost"}}.
     26<parameter>(default-remote-mailbox-hostname [HOSTNAME]) -> string</parameter>
     27
     28The host name to establish a remote mailbox connection.
     29
     30Defaults to the environment variable {{REMOTE-MAILBOX-HOSTNAME}}, or
     31{{"localhost"}} if undefined at startup.
    3532
    3633
     
    4542==== default-remote-mailbox-connect
    4643
    47 <procedure>(default-remote-mailbox-connect [PROCEDURE])</procedure>
     44<parameter>(default-remote-mailbox-connect [PROCEDURE]) -> procedure</parameter>
    4845
    4946The procedure used to establish network connections for a remote mailbox.
    5047Defaults to {{tcp-connect}} and must be signature-compatible.
    5148
     49==== default-remote-mailbox-hostname
     50
     51<parameter>(default-remote-mailbox-hostname REMOTE-MAILBOX)</parameter>
     52
     53Returns the {{REMOTE-MAILBOX}} hostname.
     54
    5255==== remote-mailbox
    5356
    54 <procedure>(remote-mailbox NAME [#:hostname HOSTNAME] [#:tcp-port TCP-PORT] [#:connect CONNECT])</procedure>
     57<procedure>(remote-mailbox NAME [#:hostname HOSTNAME] [#:tcp-port TCP-PORT] [#:connect CONNECT]) -> remote-mailbox</procedure>
    5558
    5659Returns a unique {{remote-mailbox}} object for the specified {{NAME}}.
     
    7477Returns the {{REMOTE-MAILBOX}} name.
    7578
    76 ==== default-remote-mailbox-hostname
    77 
    78 <procedure>(default-remote-mailbox-hostname REMOTE-MAILBOX)</procedure>
    79 
    80 Returns the {{REMOTE-MAILBOX}} hostname.
    81 
    8279==== remote-mailbox-tcp-port
    8380
     
    9289Is the {{REMOTE-MAILBOX}} connected? (Has it been used?)
    9390
     91==== remote-mailboxes
     92
     93<procedure>(remote-mailboxes) -> (list-of remote-mailbox)</procedure>
     94
     95Returns mailboxes.
     96
    9497==== remote-mailbox-send!
    9598
     
    104107Invalidate and forget the {{REMOTE-MAILBOX}}.
    105108
    106 ==== drop-all-remote-mailboxes
     109==== drop-remote-mailboxes!
    107110
    108111<procedure>(drop-remote-mailboxes!)</procedure>
     
    121124==== default-remote-mailbox-listen
    122125
    123 <procedure>(default-remote-mailbox-listen [PROCEDURE])</procedure>
     126<parameter>(default-remote-mailbox-listen [PROCEDURE]) -> procedure</parameter>
    124127
    125128The procedure used to establish network connections for a remote mailbox.
     
    128131==== default-remote-mailbox-auto-create?
    129132
    130 <procedure>(default-remote-mailbox-auto-create? [AUTO-CREATE?])</procedure>
     133<parameter>(default-remote-mailbox-auto-create? [AUTO-CREATE?]) -> boolean</parameter>
    131134
    132135Automatically create local-mailbox? Defaults to {{#t}}.
     
    149152==== make-remote-mailbox-server-thread
    150153
    151 <procedure>(make-remote-mailbox-server-thread REMOTE-MAILBOX-SERVER)</procedure>
     154<procedure>(make-remote-mailbox-server-thread REMOTE-MAILBOX-SERVER) -> thread</procedure>
    152155
    153156Returns a thread that, when started, will run the {{REMOTE-MAILBOX-SERVER}}.
     
    155158==== remote-mailbox-server?
    156159
    157 <procedure>(remote-mailbox-server? OBJECT)</procedure>
     160<procedure>(remote-mailbox-server? OBJECT) -> boolean</procedure>
    158161
    159162Is the {{OBJECT}} a {{remote-mailbox-server}}?
     
    161164==== remote-mailbox-server-name
    162165
    163 <procedure>(remote-mailbox-server-name REMOTE-MAILBOX-SERVER)</procedure>
     166<procedure>(remote-mailbox-server-name REMOTE-MAILBOX-SERVER) -> string</procedure>
    164167
    165168Returns the name of the specified {{REMOTE-MAILBOX-SERVER}}.
     
    167170==== remote-mailbox-server-auto-create?
    168171
    169 <procedure>(remote-mailbox-server-auto-create? REMOTE-MAILBOX-SERVER)</procedure>
     172<procedure>(remote-mailbox-server-auto-create? REMOTE-MAILBOX-SERVER) -> boolean</procedure>
    170173
    171174==== remote-mailbox-server-listener
    172175
    173 <procedure>(remote-mailbox-server-listener REMOTE-MAILBOX-SERVER)</procedure>
     176<procedure>(remote-mailbox-server-listener REMOTE-MAILBOX-SERVER) -> procedure</procedure>
    174177
    175178Returns the listener object for the specified {{REMOTE-MAILBOX-SERVER}}.
     
    177180==== remote-mailbox-server-request-limit
    178181
    179 <procedure>(remote-mailbox-server-request-limit REMOTE-MAILBOX-SERVER)</procedure>
     182<procedure>(remote-mailbox-server-request-limit REMOTE-MAILBOX-SERVER) -> fixnum</procedure>
    180183
    181184==== remote-mailbox-server-debug
     
    199202connection is closed.
    200203
    201 ==== local-mailbox/server
    202 
    203 <procedure>(local-mailbox/server REMOTE-MAILBOX-SERVER NAME)</procedure>
     204==== local-mailbox-for-server
     205
     206<procedure>(local-mailbox-for-server REMOTE-MAILBOX-SERVER NAME) -> mailbox</procedure>
    204207
    205208Returns the mailbox of {{NAME}} for {{REMOTE-MAILBOX-SERVER}} (a mailbox object
     
    210213To receive remote messages:
    211214
    212 {{(mailbox-receive! (local-mailbox/server REMOTE-MAILBOX-SERVER NAME))}}
    213 
    214 ==== drop-local-mailbox!/server
    215 
    216 <procedure>(drop-local-mailbox!/server REMOTE-MAILBOX-SERVER NAME)</procedure>
     215{{(mailbox-receive! (local-mailbox-for-server REMOTE-MAILBOX-SERVER NAME))}}
     216
     217==== drop-local-mailbox!-for-server
     218
     219<procedure>(drop-local-mailbox!-for-server REMOTE-MAILBOX-SERVER NAME)</procedure>
    217220
    218221Forget the server's mailbox.
    219222
    220 ==== local-mailbox-names/server
    221 
    222 <procedure>(local-mailbox-names/server REMOTE-MAILBOX-SERVER)</procedure>
    223 
    224 Returns a list of all the mailboxes created for the server.
     223==== local-mailbox-names-for-server
     224
     225<procedure>(local-mailbox-names-for-server REMOTE-MAILBOX-SERVER)</procedure>
     226
     227Returns a list of all the names of the mailboxes created for the server.
    225228
    226229==== local-mailbox
     
    255258==== local-mailbox-server
    256259
    257 <procedure>(local-mailbox-server) => REMOTE-MAILBOX-SERVER</procedure>
     260<procedure>(local-mailbox-server) -> remote-mailbox-server</procedure>
    258261
    259262The {{remote-mailbox-server}} object for {{local-mailbox}}.
     
    261264==== local-mailbox-thread
    262265
    263 <procedure>(local-mailbox-thread) => THREAD</procedure>
     266<procedure>(local-mailbox-thread) -> thread</procedure>
    264267
    265268The {{thread}} object for {{local-mailbox}}.
     
    276279==== serializer
    277280
    278 <procedure>(serializer [PROCEDURE])</procedure>
     281<parameter>(serializer [PROCEDURE]) -> procedure</parameter>
    279282
    280283Parameter for Scheme object serialization procedure. Default is {{s11n::serialize}}.
     
    282285==== deserializer
    283286
    284 <procedure>(deserializer [PROCEDURE])</procedure>
     287<parameter>(deserializer [PROCEDURE]) -> procedure</parameter>
    285288
    286289Parameter for Scheme object deserialization procedure. Default is {{s11n::deserialize}}.
     
    288291==== deserializer-input
    289292
    290 <procedure>(deserializer-input [INPUT-PORT])</procedure>
     293<parameter>(deserializer-input [INPUT-PORT]) -> input-port</parameter>
    291294
    292295Parameter for deserialization procedure input. Default is {{(current-input-port)}}.
     
    294297==== serializer-output
    295298
    296 <procedure>(serializer-output [OUTPUT-PORT])</procedure>
     299<parameter>(serializer-output [OUTPUT-PORT]) -> output-port</parameter>
    297300
    298301Parameter for serialization procedure output. Default is {{(current-output-port)}}.
     
    306309==== deserialize
    307310
    308 <procedure>(deserialize [INPUT-PORT (deserializer-input)]) => OBJECT</procedure>
     311<procedure>(deserialize [INPUT-PORT (deserializer-input)]) -> *</procedure>
    309312
    310313Deserialize the {{OBJECT}} from the {{INPUT-PORT}}.
     
    317320[[mailbox]]
    318321[[miscmacros]]
     322[[moremacros]]
    319323[[synch]]
    320324[[lookup-table]]
     
    342346== Version history
    343347
     348; 2.2.0 : Add types. Add {{local-mailbox-for-server}}, {{drop-local-mailbox!-for-server}}, {{local-mailbox-names-for-server}}.
    344349; 2.1.2 :
    345350; 2.1.1 :
     
    351356== License
    352357
    353 Copyright (C) 2009-2017 Kon Lovett.  All rights reserved.
     358Copyright (C) 2009-2018 Kon Lovett.  All rights reserved.
    354359
    355360Permission is hereby granted, free of charge, to any person obtaining a
Note: See TracChangeset for help on using the changeset viewer.