File: Netbuffer.html

package info (click to toggle)
ocamlnet 4.1.9-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 54,024 kB
  • sloc: ml: 151,939; ansic: 11,071; sh: 2,003; makefile: 1,310
file content (640 lines) | stat: -rw-r--r-- 39,755 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Netaddress.html">
<link rel="next" href="Netmime_header.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of extensions" rel=Appendix href="index_extensions.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Unixqueue_pollset" rel="Chapter" href="Unixqueue_pollset.html">
<link title="Unixqueue_select" rel="Chapter" href="Unixqueue_select.html">
<link title="Uq_resolver" rel="Chapter" href="Uq_resolver.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_multiplex" rel="Chapter" href="Uq_multiplex.html">
<link title="Uq_transfer" rel="Chapter" href="Uq_transfer.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Uq_io" rel="Chapter" href="Uq_io.html">
<link title="Uq_lwt" rel="Chapter" href="Uq_lwt.html">
<link title="Uq_libevent" rel="Chapter" href="Uq_libevent.html">
<link title="Uq_mt" rel="Chapter" href="Uq_mt.html">
<link title="Uq_client" rel="Chapter" href="Uq_client.html">
<link title="Uq_server" rel="Chapter" href="Uq_server.html">
<link title="Uq_datagram" rel="Chapter" href="Uq_datagram.html">
<link title="Uq_engines_compat" rel="Chapter" href="Uq_engines_compat.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Equeue_howto" rel="Chapter" href="Equeue_howto.html">
<link title="Netcamlbox" rel="Chapter" href="Netcamlbox.html">
<link title="Netcgi_apache" rel="Chapter" href="Netcgi_apache.html">
<link title="Netcgi_modtpl" rel="Chapter" href="Netcgi_modtpl.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Nethttp_client_conncache" rel="Chapter" href="Nethttp_client_conncache.html">
<link title="Nethttp_client" rel="Chapter" href="Nethttp_client.html">
<link title="Nettelnet_client" rel="Chapter" href="Nettelnet_client.html">
<link title="Netftp_data_endpoint" rel="Chapter" href="Netftp_data_endpoint.html">
<link title="Netftp_client" rel="Chapter" href="Netftp_client.html">
<link title="Nethttp_fs" rel="Chapter" href="Nethttp_fs.html">
<link title="Netftp_fs" rel="Chapter" href="Netftp_fs.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Netldap" rel="Chapter" href="Netldap.html">
<link title="Netclient_tut" rel="Chapter" href="Netclient_tut.html">
<link title="Netgss_bindings" rel="Chapter" href="Netgss_bindings.html">
<link title="Netgss" rel="Chapter" href="Netgss.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_util" rel="Chapter" href="Nethttpd_util.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netmcore" rel="Chapter" href="Netmcore.html">
<link title="Netmcore_camlbox" rel="Chapter" href="Netmcore_camlbox.html">
<link title="Netmcore_mempool" rel="Chapter" href="Netmcore_mempool.html">
<link title="Netmcore_heap" rel="Chapter" href="Netmcore_heap.html">
<link title="Netmcore_ref" rel="Chapter" href="Netmcore_ref.html">
<link title="Netmcore_array" rel="Chapter" href="Netmcore_array.html">
<link title="Netmcore_sem" rel="Chapter" href="Netmcore_sem.html">
<link title="Netmcore_mutex" rel="Chapter" href="Netmcore_mutex.html">
<link title="Netmcore_condition" rel="Chapter" href="Netmcore_condition.html">
<link title="Netmcore_queue" rel="Chapter" href="Netmcore_queue.html">
<link title="Netmcore_buffer" rel="Chapter" href="Netmcore_buffer.html">
<link title="Netmcore_matrix" rel="Chapter" href="Netmcore_matrix.html">
<link title="Netmcore_hashtbl" rel="Chapter" href="Netmcore_hashtbl.html">
<link title="Netmcore_process" rel="Chapter" href="Netmcore_process.html">
<link title="Netmcore_tut" rel="Chapter" href="Netmcore_tut.html">
<link title="Netmcore_basics" rel="Chapter" href="Netmcore_basics.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_semaphore" rel="Chapter" href="Netplex_semaphore.html">
<link title="Netplex_sharedvar" rel="Chapter" href="Netplex_sharedvar.html">
<link title="Netplex_mutex" rel="Chapter" href="Netplex_mutex.html">
<link title="Netplex_encap" rel="Chapter" href="Netplex_encap.html">
<link title="Netplex_mbox" rel="Chapter" href="Netplex_mbox.html">
<link title="Netplex_internal" rel="Chapter" href="Netplex_internal.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netplex_advanced" rel="Chapter" href="Netplex_advanced.html">
<link title="Netplex_admin" rel="Chapter" href="Netplex_admin.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Netmime_string" rel="Chapter" href="Netmime_string.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netmime_header" rel="Chapter" href="Netmime_header.html">
<link title="Netmime_channels" rel="Chapter" href="Netmime_channels.html">
<link title="Neturl_ldap" rel="Chapter" href="Neturl_ldap.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netpagebuffer" rel="Chapter" href="Netpagebuffer.html">
<link title="Netfs" rel="Chapter" href="Netfs.html">
<link title="Netglob" rel="Chapter" href="Netglob.html">
<link title="Netauth" rel="Chapter" href="Netauth.html">
<link title="Netsockaddr" rel="Chapter" href="Netsockaddr.html">
<link title="Netnumber" rel="Chapter" href="Netnumber.html">
<link title="Netxdr_mstring" rel="Chapter" href="Netxdr_mstring.html">
<link title="Netxdr" rel="Chapter" href="Netxdr.html">
<link title="Netcompression" rel="Chapter" href="Netcompression.html">
<link title="Netunichar" rel="Chapter" href="Netunichar.html">
<link title="Netasn1" rel="Chapter" href="Netasn1.html">
<link title="Netasn1_encode" rel="Chapter" href="Netasn1_encode.html">
<link title="Netoid" rel="Chapter" href="Netoid.html">
<link title="Netstring_tstring" rel="Chapter" href="Netstring_tstring.html">
<link title="Netdn" rel="Chapter" href="Netdn.html">
<link title="Netx509" rel="Chapter" href="Netx509.html">
<link title="Netascii_armor" rel="Chapter" href="Netascii_armor.html">
<link title="Nettls_support" rel="Chapter" href="Nettls_support.html">
<link title="Netmech_scram" rel="Chapter" href="Netmech_scram.html">
<link title="Netmech_scram_gssapi" rel="Chapter" href="Netmech_scram_gssapi.html">
<link title="Netmech_scram_sasl" rel="Chapter" href="Netmech_scram_sasl.html">
<link title="Netmech_scram_http" rel="Chapter" href="Netmech_scram_http.html">
<link title="Netgssapi_support" rel="Chapter" href="Netgssapi_support.html">
<link title="Netgssapi_auth" rel="Chapter" href="Netgssapi_auth.html">
<link title="Netchannels_crypto" rel="Chapter" href="Netchannels_crypto.html">
<link title="Netx509_pubkey" rel="Chapter" href="Netx509_pubkey.html">
<link title="Netx509_pubkey_crypto" rel="Chapter" href="Netx509_pubkey_crypto.html">
<link title="Netsaslprep" rel="Chapter" href="Netsaslprep.html">
<link title="Netmech_plain_sasl" rel="Chapter" href="Netmech_plain_sasl.html">
<link title="Netmech_crammd5_sasl" rel="Chapter" href="Netmech_crammd5_sasl.html">
<link title="Netmech_digest_sasl" rel="Chapter" href="Netmech_digest_sasl.html">
<link title="Netmech_digest_http" rel="Chapter" href="Netmech_digest_http.html">
<link title="Netmech_krb5_sasl" rel="Chapter" href="Netmech_krb5_sasl.html">
<link title="Netmech_gs2_sasl" rel="Chapter" href="Netmech_gs2_sasl.html">
<link title="Netmech_spnego_http" rel="Chapter" href="Netmech_spnego_http.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netsys_posix" rel="Chapter" href="Netsys_posix.html">
<link title="Netsys_pollset" rel="Chapter" href="Netsys_pollset.html">
<link title="Netlog" rel="Chapter" href="Netlog.html">
<link title="Netexn" rel="Chapter" href="Netexn.html">
<link title="Netsys_win32" rel="Chapter" href="Netsys_win32.html">
<link title="Netsys_pollset_posix" rel="Chapter" href="Netsys_pollset_posix.html">
<link title="Netsys_pollset_win32" rel="Chapter" href="Netsys_pollset_win32.html">
<link title="Netsys_pollset_generic" rel="Chapter" href="Netsys_pollset_generic.html">
<link title="Netsys_signal" rel="Chapter" href="Netsys_signal.html">
<link title="Netsys_oothr" rel="Chapter" href="Netsys_oothr.html">
<link title="Netsys_xdr" rel="Chapter" href="Netsys_xdr.html">
<link title="Netsys_rng" rel="Chapter" href="Netsys_rng.html">
<link title="Netsys_crypto_types" rel="Chapter" href="Netsys_crypto_types.html">
<link title="Netsys_types" rel="Chapter" href="Netsys_types.html">
<link title="Netsys_mem" rel="Chapter" href="Netsys_mem.html">
<link title="Netsys_tmp" rel="Chapter" href="Netsys_tmp.html">
<link title="Netsys_sem" rel="Chapter" href="Netsys_sem.html">
<link title="Netsys_pmanage" rel="Chapter" href="Netsys_pmanage.html">
<link title="Netsys_crypto" rel="Chapter" href="Netsys_crypto.html">
<link title="Netsys_tls" rel="Chapter" href="Netsys_tls.html">
<link title="Netsys_ciphers" rel="Chapter" href="Netsys_ciphers.html">
<link title="Netsys_digests" rel="Chapter" href="Netsys_digests.html">
<link title="Netsys_crypto_modes" rel="Chapter" href="Netsys_crypto_modes.html">
<link title="Netsys_gssapi" rel="Chapter" href="Netsys_gssapi.html">
<link title="Netsys_sasl_types" rel="Chapter" href="Netsys_sasl_types.html">
<link title="Netsys_sasl" rel="Chapter" href="Netsys_sasl.html">
<link title="Netsys_polypipe" rel="Chapter" href="Netsys_polypipe.html">
<link title="Netsys_polysocket" rel="Chapter" href="Netsys_polysocket.html">
<link title="Netsys_global" rel="Chapter" href="Netsys_global.html">
<link title="Nettls_gnutls_bindings" rel="Chapter" href="Nettls_gnutls_bindings.html">
<link title="Nettls_nettle_bindings" rel="Chapter" href="Nettls_nettle_bindings.html">
<link title="Nettls_gnutls" rel="Chapter" href="Nettls_gnutls.html">
<link title="Netunidata" rel="Chapter" href="Netunidata.html">
<link title="Netgzip" rel="Chapter" href="Netgzip.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_util" rel="Chapter" href="Rpc_util.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_auth_gssapi" rel="Chapter" href="Rpc_auth_gssapi.html">
<link title="Rpc_proxy" rel="Chapter" href="Rpc_proxy.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_intro_gss" rel="Chapter" href="Rpc_intro_gss.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_fs" rel="Chapter" href="Shell_fs.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Intro" rel="Chapter" href="Intro.html">
<link title="Platform" rel="Chapter" href="Platform.html">
<link title="Foreword" rel="Chapter" href="Foreword.html">
<link title="Ipv6" rel="Chapter" href="Ipv6.html">
<link title="Regexp" rel="Chapter" href="Regexp.html">
<link title="Tls" rel="Chapter" href="Tls.html">
<link title="Crypto" rel="Chapter" href="Crypto.html">
<link title="Authentication" rel="Chapter" href="Authentication.html">
<link title="Credentials" rel="Chapter" href="Credentials.html">
<link title="Gssapi" rel="Chapter" href="Gssapi.html">
<link title="Ocamlnet4" rel="Chapter" href="Ocamlnet4.html">
<link title="Get" rel="Chapter" href="Get.html"><link title="Extracting strings" rel="Section" href="#2_Extractingstrings">
<link title="Extraction with blit" rel="Section" href="#2_Extractionwithblit">
<link title="Appending strings" rel="Section" href="#2_Appendingstrings">
<link title="Inserting strings" rel="Section" href="#2_Insertingstrings">
<link title="Overwriting strings" rel="Section" href="#2_Overwritingstrings">
<link title="Deleting" rel="Section" href="#2_Deleting">
<link title="Searching" rel="Section" href="#2_Searching">
<link title="Miscelleneous" rel="Section" href="#2_Miscelleneous">
<title>Ocamlnet 4 Reference Manual : Netbuffer</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Netaddress.html" title="Netaddress">Previous</a>
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Netmime_header.html" title="Netmime_header">Next</a>
</div>
<h1>Module <a href="type_Netbuffer.html">Netbuffer</a></h1>

<pre><span id="MODULENetbuffer"><span class="keyword">module</span> Netbuffer</span>: <code class="code">sig</code> <a href="Netbuffer.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="info-desc">
<p>A Netbuffer.t is a buffer that can grow and shrink dynamically.</p>
</div>
</div>
<hr width="100%">

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>


<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">int -> <a href="Netbuffer.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Creates a netbuffer which allocates initially this number of bytes. 
 The logical length is zero.</p>
</div>
</div>

<pre><span id="VALcontents"><span class="keyword">val</span> contents</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the contents of the buffer as fresh string.</p>
</div>
</div>

<pre><span id="VALto_bytes"><span class="keyword">val</span> to_bytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> Stdlib.Bytes.t</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the contents of the buffer as fresh string.</p>
</div>
</div>

<pre><span id="VALto_tstring_poly"><span class="keyword">val</span> to_tstring_poly</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> 's <a href="Netstring_tstring.html#TYPEtstring_kind">Netstring_tstring.tstring_kind</a> -> 's</code></pre><div class="info ">
<div class="info-desc">
<p>Return the buffer in the format as selected by the arg</p>
</div>
</div>

<pre><span id="VALto_tstring"><span class="keyword">val</span> to_tstring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> 'a <a href="Netstring_tstring.html#TYPEtstring_kind">Netstring_tstring.tstring_kind</a> -> <a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a></code></pre><div class="info ">
<div class="info-desc">
<p>Returns the buffer as tagged string, selecting the chosen representation</p>
</div>
</div>

<pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Returns the logical length of the buffer</p>
</div>
</div>
<h3 id="2_Extractingstrings">Extracting strings</h3>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">get nb pos</code>: Get the character at <code class="code">pos</code></p>
</div>
</div>

<pre><span id="VALnth"><span class="keyword">val</span> nth</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char</code></pre><div class="info ">
<div class="info-desc">
<p>Alias for <code class="code">get</code></p>
</div>
</div>

<pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> string</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">sub nb k n</code>: returns the n characters starting at position <code class="code">n</code> from 
 netbuffer <code class="code">nb</code> as fresh string</p>
</div>
</div>

<pre><span id="VALsub_bytes"><span class="keyword">val</span> sub_bytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> Stdlib.Bytes.t</code></pre><div class="info ">
<div class="info-desc">
<p>Same for bytes</p>
</div>
</div>
<h3 id="2_Extractionwithblit">Extraction with blit</h3>
<pre><span id="VALblit_to_bytes"><span class="keyword">val</span> blit_to_bytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> Stdlib.Bytes.t -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">blit_to_bytes nb srcpos dest destpos len</code>: Copies the <code class="code">len</code> bytes at
 position <code class="code">srcpos</code> from <code class="code">nb</code> to the string <code class="code">dest</code> at position <code class="code">destpos</code>.</p>
</div>
</div>

<pre><span id="VALblit_to_string"><span class="keyword">val</span> blit_to_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> Stdlib.Bytes.t -> int -> int -> unit</code></pre><div class="info ">
<div class="info-deprecated">
<span class="warning">Deprecated.</span>"Use blit_to_bytes instead."</div>
</div>

<pre><span id="VALblit"><span class="keyword">val</span> blit</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> Stdlib.Bytes.t -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Compatibility name for <code class="code">blit_to_bytes</code></p>
</div>
</div>

<pre><span id="VALblit_to_memory"><span class="keyword">val</span> blit_to_memory</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> <a href="Netsys_mem.html#TYPEmemory">Netsys_mem.memory</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">blit_to_memory nb srcpos dest destpos len</code>: Copies the <code class="code">len</code> bytes at
  position <code class="code">srcpos</code> from <code class="code">nb</code> to the membuffer <code class="code">dest</code> at position
	<code class="code">destpos</code>.</p>
</div>
</div>

<pre><span id="VALblit_to_tbuffer"><span class="keyword">val</span> blit_to_tbuffer</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> <a href="Netsys_types.html#TYPEtbuffer">Netsys_types.tbuffer</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Blits to a tagged buffer</p>
</div>
</div>
<h3 id="2_Appendingstrings">Appending strings</h3>
<pre><span id="VALadd_string"><span class="keyword">val</span> add_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_string nb s</code>: Adds a copy of the string <code class="code">s</code> to the logical end of
 the netbuffer <code class="code">nb</code>. If necessary, <code class="code">nb</code> grows.</p>
</div>
</div>

<pre><span id="VALadd_bytes"><span class="keyword">val</span> add_bytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> Stdlib.Bytes.t -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for bytes</p>
</div>
</div>

<pre><span id="VALadd_tstring"><span class="keyword">val</span> add_tstring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> <a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for tagged string</p>
</div>
</div>

<pre><span id="VALadd_tstring_poly"><span class="keyword">val</span> add_tstring_poly</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> 's <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Polymorphic version</p>
</div>
</div>

<pre><span id="VALadd_substring"><span class="keyword">val</span> add_substring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_substring nb s k n</code>: Adds the substring of <code class="code">s</code> starting at position
 <code class="code">k</code> with length <code class="code">n</code> to the logical end of the netbuffer <code class="code">nb</code>. If necessary,
 <code class="code">nb</code> grows.</p>

<p>This is semantically the same as
 <code class="code">add_string nb (String.sub s k n)</code>, but the extra copy is avoided.</p>
</div>
</div>

<pre><span id="VALadd_subbytes"><span class="keyword">val</span> add_subbytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> Stdlib.Bytes.t -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for bytes</p>
</div>
</div>

<pre><span id="VALadd_subtstring"><span class="keyword">val</span> add_subtstring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> <a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for tagged string</p>
</div>
</div>

<pre><span id="VALadd_sub_string"><span class="keyword">val</span> add_sub_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> string -> int -> int -> unit</code></pre><div class="info ">
<div class="info-deprecated">
<span class="warning">Deprecated.</span>"Use add_substring instead."</div>
</div>

<pre><span id="VALadd_submemory"><span class="keyword">val</span> add_submemory</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> <a href="Netsys_mem.html#TYPEmemory">Netsys_mem.memory</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same as <code class="code">add_substring</code>, but gets data from a memory buffer</p>
</div>
</div>

<pre><span id="VALadd_sub_memory"><span class="keyword">val</span> add_sub_memory</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> <a href="Netsys_mem.html#TYPEmemory">Netsys_mem.memory</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-deprecated">
<span class="warning">Deprecated.</span>"Use add_submemory instead."</div>
</div>

<pre><span id="VALadd_subtstring_poly"><span class="keyword">val</span> add_subtstring_poly</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> 's <a href="Netstring_tstring.html#TYPEtstring_ops">Netstring_tstring.tstring_ops</a> -> 's -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Polymorphic version</p>
</div>
</div>

<pre><span id="VALadd_char"><span class="keyword">val</span> add_char</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> char -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_char nb c</code>: Adds a single char at the end of the buffer</p>
</div>
</div>

<pre><span id="VALadd_char_2"><span class="keyword">val</span> add_char_2</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> char -> char -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_char_2 nb c1 c2</code>: Adds two chars at the end of the buffer</p>
</div>
</div>

<pre><span id="VALadd_char_4"><span class="keyword">val</span> add_char_4</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> char -> char -> char -> char -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_char_4 nb c1 c2 c3 c4</code>: Adds four chars at the end of the buffer</p>
</div>
</div>

<pre><span id="VALadd_inplace"><span class="keyword">val</span> add_inplace</span> : <code class="type">?len:int -> <a href="Netbuffer.html#TYPEt">t</a> -> (Stdlib.Bytes.t -> int -> int -> int) -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_inplace nb f</code>: Calls the function <code class="code">f</code> to add bytes to the
 netbuffer <code class="code">nb</code>. The arguments of <code class="code">f</code> are the buffer, the position
 in the buffer, and the maximum length. The function <code class="code">f</code> must return
 the actual number of added bytes; this number is also returned by
 <code class="code">add_inplace</code>.</p>

<p>Example: let n = add_inplace nb (Pervasives.input ch)</p>

<p>The argument <code class="code">len</code> is the number of bytes to add (second argument of
 <code class="code">f</code>). It defaults to the number of free bytes in the buffer after space
 for at least one byte has been allocated.</p>
</div>
</div>

<pre><span id="VALadd_buffer"><span class="keyword">val</span> add_buffer</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> <a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add_buffer nb1 nb2</code>: Adds the contents of <code class="code">nb2</code> to the end of <code class="code">nb1</code></p>
</div>
</div>

<pre><span id="VALarea_for_additions"><span class="keyword">val</span> area_for_additions</span> : <code class="type">?len:int -> <a href="Netbuffer.html#TYPEt">t</a> -> Stdlib.Bytes.t * int * int</code></pre>
<pre><span id="VALadvance"><span class="keyword">val</span> advance</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>These two functions work together, so that the effect of <code class="code">add_inplace</code>
      can be obtained in two steps. First, the user calls</p>
<pre class="codepre"><code class="code">        let (s,pos,len) = area_for_additions nb
      </code></pre><p>to get the area where to put new data of length <code class="code">n</code>, with <code class="code">n &lt;= len</code>.
      After this the data is made valid by</p>
<pre class="codepre"><code class="code">        advance n
      </code></pre></div>
</div>
<h3 id="2_Insertingstrings">Inserting strings</h3>
<pre><span id="VALinsert_string"><span class="keyword">val</span> insert_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">insert_string nb p s</code>: Inserts the value of string <code class="code">s</code> at position
 <code class="code">p</code> into the netbuffer <code class="code">nb</code></p>
</div>
</div>

<pre><span id="VALinsert_substring"><span class="keyword">val</span> insert_substring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">insert_string nb p s k n</code>: Inserts a substring of string <code class="code">s</code> at position
 <code class="code">p</code> into the netbuffer <code class="code">nb</code>. The substring is denoted by position <code class="code">k</code>
 and has length <code class="code">n</code></p>
</div>
</div>

<pre><span id="VALinsert_sub_string"><span class="keyword">val</span> insert_sub_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> int -> int -> unit</code></pre><div class="info ">
<div class="info-deprecated">
<span class="warning">Deprecated.</span>"Use insert_substring instead."</div>
</div>

<pre><span id="VALinsert_subbytes"><span class="keyword">val</span> insert_subbytes</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> Stdlib.Bytes.t -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for bytes</p>
</div>
</div>

<pre><span id="VALinsert_subtstring"><span class="keyword">val</span> insert_subtstring</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> <a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for tagged string</p>
</div>
</div>

<pre><span id="VALinsert_submemory"><span class="keyword">val</span> insert_submemory</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> <a href="Netsys_types.html#TYPEmemory">Netsys_types.memory</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for memory</p>
</div>
</div>

<pre><span id="VALinsert_char"><span class="keyword">val</span> insert_char</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">insert_char nb p c</code>: Inserts character <code class="code">c</code> at position <code class="code">p</code> into
 the netbuffer <code class="code">nb</code></p>
</div>
</div>
<h3 id="2_Overwritingstrings">Overwriting strings</h3>
<pre><span id="VALset"><span class="keyword">val</span> set</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">set nb pos c</code>: Sets the character at <code class="code">pos</code> to <code class="code">c</code></p>
</div>
</div>

<pre><span id="VALput_string"><span class="keyword">val</span> put_string</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> string -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">put_string nb pos s</code>: Copies the string <code class="code">s</code> to the position <code class="code">pos</code>
        of netbuffer <code class="code">nb</code></p>
</div>
</div>

<pre><span id="VALblit_from_string"><span class="keyword">val</span> blit_from_string</span> : <code class="type">string -> int -> <a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">blit_from_string src srcpos dest destpos len</code>: Copies the <code class="code">len</code> bytes
 at position <code class="code">srcpos</code> from the string <code class="code">src</code> to the netbuffer <code class="code">dest</code> at
 position <code class="code">destpos</code>.</p>

<p>It is possible to copy the string beyond the end of the buffer. The
 buffer is automatically enlarged in this case.</p>
</div>
</div>

<pre><span id="VALblit_from_bytes"><span class="keyword">val</span> blit_from_bytes</span> : <code class="type">Stdlib.Bytes.t -> int -> <a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for bytes</p>
</div>
</div>

<pre><span id="VALblit_from_memory"><span class="keyword">val</span> blit_from_memory</span> : <code class="type"><a href="Netsys_types.html#TYPEmemory">Netsys_types.memory</a> -> int -> <a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for memory</p>
</div>
</div>

<pre><span id="VALblit_from_tstring"><span class="keyword">val</span> blit_from_tstring</span> : <code class="type"><a href="Netsys_types.html#TYPEtstring">Netsys_types.tstring</a> -> int -> <a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Same for tagged string</p>
</div>
</div>
<h3 id="2_Deleting">Deleting</h3>
<pre><span id="VALdelete"><span class="keyword">val</span> delete</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> int -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">delete nb k n</code>: Deletes the <code class="code">n</code> bytes at position <code class="code">k</code> of netbuffer 
 <code class="code">nb</code> in-place.</p>

<p>The netbuffer does not shrink, however, i.e. the free space is not
 given back to the memory manager.</p>
</div>
</div>

<pre><span id="VALclear"><span class="keyword">val</span> clear</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Deletes all contents from the buffer. As <code class="code">delete</code>, the netbuffer does
 not shrink.</p>
</div>
</div>

<pre><span id="VALreset"><span class="keyword">val</span> reset</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Empty the buffer, deallocate the internal string, and replace it
        with a new string of length <code class="code">n</code> that was allocated by
        <a href="Netbuffer.html#VALcreate"><code class="code">Netbuffer.create</code></a> <code class="code">n</code>.</p>
</div>
</div>

<pre><span id="VALtry_shrinking"><span class="keyword">val</span> try_shrinking</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">try_shrinking nb</code>: If the length of the buffer is less than half of
 the allocated space, the netbuffer is reallocated in order to save
 memory.</p>
</div>
</div>
<h3 id="2_Searching">Searching</h3>
<pre><span id="VALindex_from"><span class="keyword">val</span> index_from</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> int -> char -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">index_from nb k c</code>: Searches the character <code class="code">c</code> in the netbuffer beginning
 at position <code class="code">k</code>. If found, the position of the left-most occurence is
 returned. Otherwise, <code class="code">Not_found</code> is raised.</p>
</div>
</div>
<h3 id="2_Miscelleneous">Miscelleneous</h3>
<pre><span id="VALunsafe_buffer"><span class="keyword">val</span> unsafe_buffer</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> Stdlib.Bytes.t</code></pre><div class="info ">
<div class="info-desc">
<p><b>Warning! This is a low-level function!</b>
 Returns the current string that internally holds the buffer.
 The byte positions 0 to length - 1 actually store the contents of
 the buffer. You can directly read and modify the buffer. Note that
 there is no protection if you read or write positions beyond the
 length of the buffer.</p>
</div>
</div>

<pre><span id="VALprint_buffer"><span class="keyword">val</span> print_buffer</span> : <code class="type"><a href="Netbuffer.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>For the toploop</p>
</div>
</div>
</body></html>