← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ocamlnet/trusty

« back to all changes in this revision

Viewing changes to doc/html-main/Netstream.in_obj_stream.html

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu
  • Date: 2011-09-02 14:12:33 UTC
  • mfrom: (18.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110902141233-zbj0ygxb92u6gy4z
Tags: 3.4-1
http://bugs.debian.org/637147
* New upstream release
  - add a new NetcgiRequire directive to ease dependency management
    (Closes: #637147)
  - remove patches that were applied upstream:
    + Added-missing-shebang-lines-in-example-shell-scripts
    + Try-also-ocamlc-for-POSIX-threads

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html-main/Netstream.in_obj_stream.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="Up" href="Netstream.html">
8
 
<link title="Index of types" rel=Appendix href="index_types.html">
9
 
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
10
 
<link title="Index of values" rel=Appendix href="index_values.html">
11
 
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
12
 
<link title="Index of class methods" rel=Appendix href="index_methods.html">
13
 
<link title="Index of classes" rel=Appendix href="index_classes.html">
14
 
<link title="Index of class types" rel=Appendix href="index_class_types.html">
15
 
<link title="Index of modules" rel=Appendix href="index_modules.html">
16
 
<link title="Index of module types" rel=Appendix href="index_module_types.html">
17
 
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
18
 
<link title="Equeue" rel="Chapter" href="Equeue.html">
19
 
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
20
 
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
21
 
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
22
 
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
23
 
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
24
 
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
25
 
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
26
 
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
27
 
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
28
 
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
29
 
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
30
 
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
31
 
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
32
 
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
33
 
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
34
 
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
35
 
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
36
 
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
37
 
<link title="Http_client" rel="Chapter" href="Http_client.html">
38
 
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
39
 
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
40
 
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
41
 
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
42
 
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
43
 
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
44
 
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
45
 
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
46
 
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
47
 
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
48
 
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
49
 
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
50
 
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
51
 
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
52
 
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
53
 
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
54
 
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
55
 
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
56
 
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
57
 
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
58
 
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
59
 
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
60
 
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
61
 
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
62
 
<link title="Netshm" rel="Chapter" href="Netshm.html">
63
 
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
64
 
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
65
 
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
66
 
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
67
 
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
68
 
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
69
 
<link title="Netstream" rel="Chapter" href="Netstream.html">
70
 
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
71
 
<link title="Netmime" rel="Chapter" href="Netmime.html">
72
 
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
73
 
<link title="Neturl" rel="Chapter" href="Neturl.html">
74
 
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
75
 
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
76
 
<link title="Netdate" rel="Chapter" href="Netdate.html">
77
 
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
78
 
<link title="Netulex" rel="Chapter" href="Netulex.html">
79
 
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
80
 
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
81
 
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
82
 
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
83
 
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
84
 
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
85
 
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
86
 
<link title="Netaux" rel="Chapter" href="Netaux.html">
87
 
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
88
 
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
89
 
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
90
 
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
91
 
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
92
 
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
93
 
<link title="Netsys" rel="Chapter" href="Netsys.html">
94
 
<link title="Netpop" rel="Chapter" href="Netpop.html">
95
 
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
96
 
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
97
 
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
98
 
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
99
 
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
100
 
<link title="Xdr" rel="Chapter" href="Xdr.html">
101
 
<link title="Rpc" rel="Chapter" href="Rpc.html">
102
 
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
103
 
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
104
 
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
105
 
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
106
 
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
107
 
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
108
 
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
109
 
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
110
 
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
111
 
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
112
 
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
113
 
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
114
 
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
115
 
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
116
 
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
117
 
<link title="Shell" rel="Chapter" href="Shell.html">
118
 
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
119
 
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
120
 
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
121
 
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Netstream.in_obj_stream</title>
122
 
</head>
123
 
<body>
124
 
<div class="navbar">&nbsp;<a href="Netstream.html">Up</a>
125
 
&nbsp;</div>
126
 
<center><h1>Class type <a href="type_Netstream.in_obj_stream.html">Netstream.in_obj_stream</a></h1></center>
127
 
<br>
128
 
<pre><span class="keyword">class type</span> <a name="TYPEin_obj_stream"></a>in_obj_stream = <code class="code">object</code> <a href="Netstream.in_obj_stream.html">..</a> <code class="code">end</code></pre>An <code class="code">in_obj_stream</code> extends <code class="code">in_obj_channel</code> by look-ahead methods<br>
129
 
<b>Inherits</b><ul>
130
 
<li><a href="Netchannels.in_obj_channel.html"><code class="code">Netchannels.in_obj_channel</code></a>    The normal input operations work as usual. The window is moved after
131
 
 every read sequence of bytes by exactly the number of bytes, and 
132
 
 if the window length becomes smaller than the block size, it will
133
 
 be ensured that the window will be enlarged to the block size (or
134
 
 to the rest of the stream until EOF, whatever is smaller).</li>
135
 
</ul>
136
 
<hr width="100%">
137
 
<pre><span class="keyword">method</span> <a name="METHODblock_size"></a>block_size : <code class="type">int</code></pre><div class="info">
138
 
The block size of the stream<br>
139
 
</div>
140
 
<pre><span class="keyword">method</span> <a name="METHODwindow"></a>window : <code class="type"><a href="Netbuffer.html#TYPEt">Netbuffer.t</a></code></pre><div class="info">
141
 
The look-ahead window. The first byte of the window is the byte that
142
 
 would be read next by <code class="code">input_char</code>. The length of the window is returned
143
 
 by the method <code class="code">window_length</code>. This length may be smaller than the
144
 
 current length of the netbuffer, i.e. the netbuffer may contain 
145
 
 additional data that must be ignored.<br>
146
 
</div>
147
 
<pre><span class="keyword">method</span> <a name="METHODwant"></a>want : <code class="type">int -> unit</code></pre><div class="info">
148
 
Increases the length of the window such that the length is at least
149
 
 the passed number of bytes or that the window reaches EOF (whatever
150
 
 happens first).<br>
151
 
</div>
152
 
<pre><span class="keyword">method</span> <a name="METHODwant_another_block"></a>want_another_block : <code class="type">unit -> unit</code></pre><div class="info">
153
 
The same as: <code class="code">want block_size</code><br>
154
 
</div>
155
 
<pre><span class="keyword">method</span> <a name="METHODwindow_length"></a>window_length : <code class="type">int</code></pre><div class="info">
156
 
Returns the length of the window<br>
157
 
</div>
158
 
<pre><span class="keyword">method</span> <a name="METHODwindow_at_eof"></a>window_at_eof : <code class="type">bool</code></pre><div class="info">
159
 
Whether the window is at eof<br>
160
 
</div>
161
 
<pre><span class="keyword">method</span> <a name="METHODskip"></a>skip : <code class="type">int -> unit</code></pre><div class="info">
162
 
Skip the n bytes of the stream. It is not an error to skip more bytes
163
 
 than available in the remaining stream.<br>
164
 
</div>
165
 
</body></html>
 
 
b'\\ No newline at end of file'