Changeset 35357 in project


Ignore:
Timestamp:
03/26/18 19:42:33 (6 months ago)
Author:
kon
Message:

rel 2.3.1

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/mailbox

    r35028 r35357  
    1313=== mailbox-timeout-condition?
    1414
    15 <procedure>(mailbox-timeout-condition? OBJ) => boolean</procedure>
     15<procedure>(mailbox-timeout-condition? OBJ) -> boolean</procedure>
    1616
    1717Is the {{OBJ}} a mailbox timeout condition?
     
    3232=== mailbox-timeout-exception?
    3333
    34 <procedure>(mailbox-timeout-exception? OBJ) => boolean</procedure>
     34<procedure>(mailbox-timeout-exception? OBJ) -> boolean</procedure>
    3535
    3636Synonym of {{mailbox-timeout-condition?}}.
     
    3838=== make-mailbox
    3939
    40 <procedure>(make-mailbox [NAME]) => mailbox</procedure>
     40<procedure>(make-mailbox [NAME]) -> mailbox</procedure>
    4141
    4242Returns a new mailbox object.
    4343
    44 {{NAME}} is an optional object to identify this mailbox and defaults to
    45 {{(gensym 'mailbox)}}.
     44; {{NAME}} : {{*}} ; default {{(gensym 'mailbox)}}
     45
     46* identify this mailbox.
    4647
    4748=== mailbox?
    4849
    49 <procedure>(mailbox? OBJ) => boolean</procedure>
     50<procedure>(mailbox? OBJ) -> boolean</procedure>
    5051
    5152Is the {{OBJ}} a {{mailbox}}?
     
    5354=== mailbox-name
    5455
    55 <procedure>(mailbox-name MAILBOX) => *</procedure>
     56<procedure>(mailbox-name MAILBOX) -> *</procedure>
    5657
    5758Returns the name of the {{MAILBOX}}.
     
    5960=== mailbox-empty?
    6061
    61 <procedure>(mailbox-empty? MAILBOX) => boolean</procedure>
     62<procedure>(mailbox-empty? MAILBOX) -> boolean</procedure>
    6263
    6364If there are no queued objects in the {{MAILBOX}}, then
     
    6667=== mailbox-count
    6768
    68 <procedure>(mailbox-count MAILBOX) => integer</procedure>
     69<procedure>(mailbox-count MAILBOX) -> integer</procedure>
    6970
    7071Returns the number of queued objects for the {{MAILBOX}}.
     
    7273=== mailbox-waiting?
    7374
    74 <procedure>(mailbox-waiting? MAILBOX) => boolean</procedure>
     75<procedure>(mailbox-waiting? MAILBOX) -> boolean</procedure>
    7576
    7677Is any thread waiting for the {{MAILBOX}}?
     
    7879=== mailbox-waiters
    7980
    80 <procedure>(mailbox-waiters MAILBOX) => list</procedure>
     81<procedure>(mailbox-waiters MAILBOX) -> list</procedure>
    8182
    8283Returns a list of the threads waiting for the {{MAILBOX}}.
     
    9394=== mailbox-receive!
    9495
    95 <procedure>(mailbox-receive! MAILBOX [TIMEOUT [DEFAULT]]) => *</procedure>
     96<procedure>(mailbox-receive! MAILBOX [TIMEOUT [DEFAULT]]) -> *</procedure>
    9697
    9798If there is any data in the {{MAILBOX}}, then the first object will be
     
    134135=== make-mailbox-cursor
    135136
    136 <procedure>(make-mailbox-cursor MAILBOX) => mailbox-cursor</procedure>
     137<procedure>(make-mailbox-cursor MAILBOX) -> mailbox-cursor</procedure>
    137138
    138139Returns an object which can enumerate a mailbox.
     
    142143=== mailbox-cursor?
    143144
    144 <procedure>(mailbox-cursor? OBJ) => boolean</procedure>
     145<procedure>(mailbox-cursor? OBJ) -> boolean</procedure>
    145146
    146147Is the {{OBJ}} a {{mailbox-cursor}}?
     
    148149=== mailbox-cursor-mailbox
    149150
    150 <procedure>(mailbox-cursor-mailbox MAILBOX-CURSOR) => mailbox</procedure>
     151<procedure>(mailbox-cursor-mailbox MAILBOX-CURSOR) -> mailbox</procedure>
    151152
    152153Returns the mailbox object associated with the mailbox cursor.
     
    154155=== mailbox-cursor-next
    155156
    156 <procedure>(mailbox-cursor-next MAILBOX-CURSOR [TIMEOUT [DEFAULT]]) => *</procedure>
     157<procedure>(mailbox-cursor-next MAILBOX-CURSOR [TIMEOUT [DEFAULT]]) -> *</procedure>
    157158
    158159Returns the next object in the mailbox queue, waiting if necessary.
     
    186187=== mailbox-cursor-rewound?
    187188
    188 <procedure>(mailbox-cursor-rewound? MAILBOX-CURSOR) => boolean</procedure>
     189<procedure>(mailbox-cursor-rewound? MAILBOX-CURSOR) -> boolean</procedure>
    189190
    190191Is the {{MAILBOX-CURSOR}} positioned at the start of the mailbox queue?
     
    192193=== mailbox-cursor-unwound?
    193194
    194 <procedure>(mailbox-cursor-unwound? MAILBOX-CURSOR) => boolean</procedure>
     195<procedure>(mailbox-cursor-unwound? MAILBOX-CURSOR) -> boolean</procedure>
    195196
    196197Is the {{MAILBOX-CURSOR}} positioned at the end of the mailbox queue?
     
    269270== Version history
    270271
     272; 2.3.1 : Fix name type.
     273; 2.3.0 : Add types.
    271274; 2.2.3 :
    272275; 2.2.2 : Expand {{mailbox-timeout-condition}}.
Note: See TracChangeset for help on using the changeset viewer.