Home My Page Projects Code Snippets Project Openings SML/NJ
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files

SCM Repository

[smlnj] Diff of /sml/branches/SMLNJ/src/cml/doc/ML-Doc/mailbox.mldoc
ViewVC logotype

Diff of /sml/branches/SMLNJ/src/cml/doc/ML-Doc/mailbox.mldoc

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 105, Thu May 28 21:30:17 1998 UTC revision 106, Thu May 28 21:30:17 1998 UTC
# Line 2  Line 2 
2    
3  <!DOCTYPE ML-DOC SYSTEM>  <!DOCTYPE ML-DOC SYSTEM>
4    
5    <COPYRIGHT OWNER="Bell Labs, Lucent Technologies" YEAR=1998>
6  <COPYRIGHT OWNER="AT&AMP;T Research" YEAR=1996>  <COPYRIGHT OWNER="AT&AMP;T Research" YEAR=1996>
7  <VERSION VERID="1.0" YEAR=1996 MONTH=4 DAY=21>  <VERSION VERID="1.0" YEAR=1996 MONTH=4 DAY=21>
8  <TITLE>The Mailbox structure</TITLE>  <TITLE>The Mailbox structure</TITLE>
9    
10  <SECT>  <INTERFACE>
11  <HEAD>The <STRREF TOPID NOLINK/Mailbox/ structure</HEAD>  <HEAD>The <STRREF TOPID NOLINK/Mailbox/ structure</HEAD>
12    <SEEALSO>
13      <STRREF TOPID/CML/
14    </SEEALSO>
15    
16  <PP>  <PP>
17  The <STRREF TOPID NOLINK/Mailbox/ structure provides buffered asynchronous  The <STRREF TOPID NOLINK/Mailbox/ structure provides buffered asynchronous
# Line 18  Line 22 
22      <SPEC>      <SPEC>
23        <TYPE><TYPARAM>'a<ID>mbox        <TYPE><TYPARAM>'a<ID>mbox
24        <COMMENT>        <COMMENT>
25            <PP>
26          This is the type constructor for a mailbox.          This is the type constructor for a mailbox.
27          A mailbox is an unbounded, buffered communication channel.          A mailbox is an unbounded, buffered communication channel.
28      <SPEC>      <SPEC>
# Line 63  Line 68 
68      <SPEC>      <SPEC>
69        <VAL>recvPoll<TY>'a mbox -> 'a option        <VAL>recvPoll<TY>'a mbox -> 'a option
70        <COMMENT>        <COMMENT>
71            <PP>
72          This is the non-blocking version of <VALREF/recv/.          This is the non-blocking version of <VALREF/recv/.
73          If the corresponding blocking form would block (because the mailbox is          If the corresponding blocking form would block (because the mailbox is
74          empty), then this returns          empty), then this returns
75          <CONREF DOCUMENT=SML-BASIS-DOC STRID="Option"/NONE/, otherwise it returns          <CONREF DOCUMENT=SML-BASIS-DOC STRID="Option"/NONE/, otherwise it returns
76          <CONREF DOCUMENT=SML-BASIS-DOC STRID="Option"/SOME/ of the received          <CONREF DOCUMENT=SML-BASIS-DOC STRID="Option"/SOME/ of the received
77          message.          message.
78      <DISCUSS>  </STRUCTURE>
79    <PP>
80        Note that mailbox buffers are unbounded, which means that there is no flow        Note that mailbox buffers are unbounded, which means that there is no flow
81        control to prevent a producer from greatly outstriping a consumer, and thus        control to prevent a producer from greatly outstriping a consumer, and thus
82        exhausting memory.        exhausting memory.
# Line 77  Line 84 
84        <VALREF STRID="Mailbox"/send/ operations, it is recommended that the        <VALREF STRID="Mailbox"/send/ operations, it is recommended that the
85        synchronous channels from the <STRREF TOPID/CML/ structure        synchronous channels from the <STRREF TOPID/CML/ structure
86        be used instead.        be used instead.
87      <SEEALSO>  </INTERFACE>
       <STRREF TOPID/CML/  
     </SEEALSO>  
 </STRUCTURE>  

Legend:
Removed from v.105  
changed lines
  Added in v.106

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0