← Back to branch summary

~ubuntu-branches/ubuntu/natty/ocamlnet/natty

« back to all changes in this revision

Viewing changes to doc/html-main/Uq_engines.output_async_mplex.html

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Zacchiroli
  • Date: 2007-04-11 21:09:18 UTC
  • mfrom: (1.2.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070411210918-keupynp43rhwwbig
Tags: 2.2.7-1
* New upstream release
* Uploading ocamlnet 2.2.x to unstable
* debian/rules
  - removed -enable-modcaml, no longer supported upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html-main/Uq_engines.output_async_mplex.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<link rel="stylesheet" href="style.css" type="text/css">
 
5
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
 
6
<link rel="Start" href="index.html">
 
7
<link rel="previous" href="Uq_engines.direct_socket_acceptor.html">
 
8
<link rel="next" href="Uq_engines.input_async_mplex.html">
 
9
<link rel="Up" href="Uq_engines.html">
 
10
<link title="Index of types" rel=Appendix href="index_types.html">
 
11
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
 
12
<link title="Index of values" rel=Appendix href="index_values.html">
 
13
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
 
14
<link title="Index of class methods" rel=Appendix href="index_methods.html">
 
15
<link title="Index of classes" rel=Appendix href="index_classes.html">
 
16
<link title="Index of class types" rel=Appendix href="index_class_types.html">
 
17
<link title="Index of modules" rel=Appendix href="index_modules.html">
 
18
<link title="Index of module types" rel=Appendix href="index_module_types.html">
 
19
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
 
20
<link title="Equeue" rel="Chapter" href="Equeue.html">
 
21
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
 
22
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
 
23
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
 
24
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
 
25
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
 
26
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
 
27
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
 
28
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
 
29
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
 
30
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
 
31
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
 
32
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
 
33
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
 
34
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
 
35
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
 
36
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
 
37
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
 
38
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
 
39
<link title="Http_client" rel="Chapter" href="Http_client.html">
 
40
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
 
41
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
 
42
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
 
43
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
 
44
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
 
45
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
 
46
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
 
47
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
 
48
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
 
49
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
 
50
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
 
51
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
 
52
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
 
53
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
 
54
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
 
55
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
 
56
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
 
57
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
 
58
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
 
59
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
 
60
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
 
61
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
 
62
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
 
63
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
 
64
<link title="Netshm" rel="Chapter" href="Netshm.html">
 
65
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
 
66
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
 
67
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
 
68
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
 
69
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
 
70
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
 
71
<link title="Netstream" rel="Chapter" href="Netstream.html">
 
72
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
 
73
<link title="Netmime" rel="Chapter" href="Netmime.html">
 
74
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
 
75
<link title="Neturl" rel="Chapter" href="Neturl.html">
 
76
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
 
77
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
 
78
<link title="Netdate" rel="Chapter" href="Netdate.html">
 
79
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
 
80
<link title="Netulex" rel="Chapter" href="Netulex.html">
 
81
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
 
82
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
 
83
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
 
84
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
 
85
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
 
86
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
 
87
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
 
88
<link title="Netaux" rel="Chapter" href="Netaux.html">
 
89
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
 
90
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
 
91
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
 
92
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
 
93
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
 
94
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
 
95
<link title="Netsys" rel="Chapter" href="Netsys.html">
 
96
<link title="Netpop" rel="Chapter" href="Netpop.html">
 
97
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
 
98
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
 
99
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
 
100
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
 
101
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
 
102
<link title="Xdr" rel="Chapter" href="Xdr.html">
 
103
<link title="Rpc" rel="Chapter" href="Rpc.html">
 
104
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
 
105
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
 
106
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
 
107
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
 
108
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
 
109
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
 
110
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
 
111
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
 
112
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
 
113
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
 
114
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
 
115
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
 
116
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
 
117
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
 
118
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
 
119
<link title="Shell" rel="Chapter" href="Shell.html">
 
120
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
 
121
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
 
122
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
 
123
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Uq_engines.output_async_mplex</title>
 
124
</head>
 
125
<body>
 
126
<div class="navbar"><a href="Uq_engines.direct_socket_acceptor.html">Previous</a>
 
127
&nbsp;<a href="Uq_engines.html">Up</a>
 
128
&nbsp;<a href="Uq_engines.input_async_mplex.html">Next</a>
 
129
</div>
 
130
<center><h1>Class <a href="type_Uq_engines.output_async_mplex.html">Uq_engines.output_async_mplex</a></h1></center>
 
131
<br>
 
132
<pre><span class="keyword">class</span> <a name="TYPEoutput_async_mplex"></a>output_async_mplex : <code class="type">?onclose:[ `Ignore | `Write_eof ] -> ?onshutdown:<a href="Uq_engines.html#TYPEonshutdown_out_spec">onshutdown_out_spec</a> -> ?buffer_size:int -> <a href="Uq_engines.multiplex_controller.html">multiplex_controller</a> -> </code><code class="type"><a href="Uq_engines.async_out_channel_engine.html">async_out_channel_engine</a></code></pre>Creates an asynchronous output channel writing to the multiplex
 
133
 controller (see also <code class="code">output_async_descr</code> for the corresponding
 
134
 class writing to a single descriptor).
 
135
<p>
 
136
 
 
137
 <code class="code">onclose</code>: What to do when the <code class="code">close_out</code> method is invoked.
 
138
 Defaults to <code class="code">`Ignore</code>. <code class="code">`Write_eof</code> means to write the EOF marker.
 
139
 Anyway, after doing the close action, the multiplex controller
 
140
 is shutdown.
 
141
<p>
 
142
 
 
143
 <code class="code">onshutdown</code>: What to do when all data (and optionally, the EOF marker)
 
144
 have been written. It is also invoked in case of I/O errors.
 
145
 The default is <code class="code">`Ignore</code>. The value <code class="code">`Initiate_shutdown</code> means that
 
146
 it is started to shutdown the socket. The success of this action
 
147
 is not waited upon, however. One can also pass <code class="code">`Action f</code> in which
 
148
 case the function <code class="code">f</code> is called with this object, the
 
149
 multiplex controller, and the proposed next state as arguments. 
 
150
 By checking the proposed next state the function can see why the
 
151
 shutdown function was called.
 
152
<p>
 
153
 
 
154
 <code class="code">buffer_size</code>: The size of the internal buffer. By default unlimited.
 
155
<p>
 
156
 
 
157
 Note that the engine is done when the output channel is closed.
 
158
 The socket is not shut down, and the underlying file descriptor
 
159
 is not closed! You can define the <code class="code">shutdown</code> callback to do something
 
160
 in this case.<br>
 
161
<hr width="100%">
 
162
</body></html>
 
 
b'\\ No newline at end of file'