Changeset 34357 in project


Ignore:
Timestamp:
08/25/17 18:47:44 (4 weeks ago)
Author:
kon
Message:

updt primordial timeout note, updt -condition doc, add eggs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/mailbox

    r34356 r34357  
    1111Thread-safe queues with timeout.
    1212
     13=== mailbox-timeout-condition?
     14
     15<procedure>(mailbox-timeout-condition? OBJ) => boolean</procedure>
     16
     17Is the {{OBJ}} a mailbox timeout condition?
     18
     19A mailbox timeout condition is a composite condition of {{'exn}},
     20{{'mailbox}}, and {{'timeout}} conditions. The {{'exn}} condition has
     21properties of {{'location}}, {{'message}}, {{'arguments}}, and maybe
     22{{'call-chain}}.
     23
    1324=== mailbox-timeout-exception?
    1425
    15 <procedure>(mailbox-timeout-exception? *) => boolean</procedure>
    16 
    17 Is the {{*}} a mailbox timeout exception?
    18 
    19 A mailbox timeout exception is a composite condition of {{'exn}},
    20 {{'mailbox}}, and {{'timeout}}, with properties of {{'location}} and
    21 {{'arguments}}.
     26<procedure>(mailbox-timeout-exception? OBJ) => boolean</procedure>
     27
     28Synonym of {{mailbox-timeout-condition?}}.
    2229
    2330=== make-mailbox
     
    2532<procedure>(make-mailbox [NAME]) => mailbox</procedure>
    2633
    27 Returns a new mailbox object. {{NAME}} is an optional object to identify
    28 this mailbox and defaults to some {{gensym}}'d symbol.
     34Returns a new mailbox object.
     35
     36{{NAME}} is an optional object to identify this mailbox and defaults to
     37{{(gensym 'mailbox)}}.
    2938
    3039=== mailbox?
    3140
    32 <procedure>(mailbox? *) => boolean</procedure>
    33 
    34 Is the {{*}} a {{mailbox}}?
     41<procedure>(mailbox? OBJ) => boolean</procedure>
     42
     43Is the {{OBJ}} a {{mailbox}}?
    3544
    3645=== mailbox-name
     
    6776=== mailbox-send!
    6877
    69 <procedure>(mailbox-send! MAILBOX X)</procedure>
    70 
    71 Queues the data object {{X}}. If any threads exist that are waiting
     78<procedure>(mailbox-send! MAILBOX OBJ)</procedure>
     79
     80Queues the data object {{OBJ}}. If any threads exist that are waiting
    7281for input on {{MAILBOX}}, the execution of the first one will be
    7382resumed. The data will be read out of a mailbox in the same order in
     
    104113=== mailbox-push-back!
    105114
    106 <procedure>(mailbox-push-back! MAILBOX X)</procedure>
    107 
    108 Pushes the data object {{X}} into the first position of a mailbox.
     115<procedure>(mailbox-push-back! MAILBOX OBJ)</procedure>
     116
     117Pushes the data object {{OBJ}} into the first position of a mailbox.
    109118
    110119=== mailbox-push-back-list!
    111120
    112 <procedure>(mailbox-push-back-list! MAILBOX XS)</procedure>
    113 
    114 Pushes the list of objects {{XS}} back into the mailbox, so that {{(car
    115 XS)}} becomes the next receivable item.
     121<procedure>(mailbox-push-back-list! MAILBOX OBJS)</procedure>
     122
     123Pushes the list of objects {{OBJS}} back into the mailbox, so that {{(car
     124OBJS)}} becomes the next receivable item.
    116125
    117126=== make-mailbox-cursor
     
    125134=== mailbox-cursor?
    126135
    127 <procedure>(mailbox-cursor? *) => boolean</procedure>
    128 
    129 Is the {{*}} a {{mailbox-cursor}}?
     136<procedure>(mailbox-cursor? OBJ) => boolean</procedure>
     137
     138Is the {{OBJ}} a {{mailbox-cursor}}?
    130139
    131140=== mailbox-cursor-mailbox
     
    233242mailbox. The current state of the mailbox is queried.
    234243
     244* {{mailbox-timeout-exception?}} will be deprecated.
    235245
    236246== Author
     
    244254
    245255[[check-errors]]
     256[[condition-utils]]
     257[[record-variants]]
     258[[setup-helper]]
    246259
    247260
Note: See TracChangeset for help on using the changeset viewer.