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
|
<!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="Netmcore_basics.html">
<link rel="next" href="Netplex_mp.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"><title>Ocamlnet 4 Reference Manual : Netplex_types</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Netmcore_basics.html" title="Netmcore_basics">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Netplex_mp.html" title="Netplex_mp">Next</a>
</div>
<h1>Module <a href="type_Netplex_types.html">Netplex_types</a></h1>
<pre><span id="MODULENetplex_types"><span class="keyword">module</span> Netplex_types</span>: <code class="code">sig</code> <a href="Netplex_types.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="info-desc">
<p>Types for <code class="code">Netplex</code></p>
</div>
</div>
<hr width="100%">
<pre><span id="TYPEencap"><span class="keyword">type</span> <code class="type"></code>encap</span> = <code class="type"><a href="Netplex_encap.html#TYPEencap">Netplex_encap.encap</a></code> </pre>
<pre><span id="TYPEparam_value"><span class="keyword">type</span> <code class="type"></code>param_value</span> = <code class="type">[ `Bool of bool | `Float of float | `Int of int | `String of string ]</code> </pre>
<pre><span id="TYPEparam_value_or_any"><span class="keyword">type</span> <code class="type"></code>param_value_or_any</span> = <code class="type">[ `Any of exn<br> | `Bool of bool<br> | `Encap of <a href="Netplex_types.html#TYPEencap">encap</a><br> | `Float of float<br> | `Int of int<br> | `String of string ]</code> </pre>
<pre><span id="TYPElevel"><span class="keyword">type</span> <code class="type"></code>level</span> = <code class="type">[ `Alert | `Crit | `Debug | `Emerg | `Err | `Info | `Notice | `Warning ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>Log levels, modeled after syslog</p>
</div>
</div>
<pre><span id="TYPElogger"><span class="keyword">class type</span> <a href="Netplex_types.logger-c.html">logger</a></span> = <code class="code">object</code> <a href="Netplex_types.logger-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>A logger receives log messages</p>
</div>
<pre><span id="TYPEparallelization_type"><span class="keyword">type</span> <code class="type"></code>parallelization_type</span> = <code class="type">[ `Controller_attached | `Multi_processing | `Multi_threading ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>Type of parallelization:</p>
<ul>
<li><code class="code">`Multi_processing</code> on a single host</li>
<li><code class="code">`Multi_threading</code> on a single host</li>
<li><code class="code">`Controller_attached</code> means that the service runs within the
controller. This is (for now) only allowed for controller-internal
services.</li>
</ul>
</div>
</div>
<pre><span id="TYPEthread_sys_id"><span class="keyword">type</span> <code class="type"></code>thread_sys_id</span> = <code class="type">[ `Process of int | `Thread of int ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>A system-specific identifier of the thread/process</p>
</div>
</div>
<pre><span id="TYPEsocket_state"><span class="keyword">type</span> <code class="type"></code>socket_state</span> = <code class="type">[ `Disabled | `Down | `Enabled | `Restarting of bool ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>The state of a socket:</p>
<ul>
<li><code class="code">`Enabled</code>: The controller allows containers to accept connections.
Note that this does not necessarily means that there such containers.</li>
<li><code class="code">`Disabled</code>: It is not allowed to accept new connections. The
socket is kept open, however.</li>
<li><code class="code">`Restarting b</code>: The containers are being restarted. The boolean
argument says whether the socket will be enabled after that.</li>
<li><code class="code">`Down</code>: The socket is down/closed</li>
</ul>
</div>
</div>
<pre><span id="TYPEcontainer_id"><span class="keyword">type</span> <code class="type"></code>container_id</span> = <</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcontainer_id.socket_service_name">socket_service_name</span> : <code class="type">string</code>;</code></td>
</tr></table>
>
</pre>
<div class="info ">
<div class="info-desc">
<p>Such objects identify containers. As additional info, the method
<code class="code">socket_service_name</code> returns the name of the socket service the
container implements</p>
</div>
</div>
<pre><span id="TYPEcontainer_state"><span class="keyword">type</span> <code class="type"></code>container_state</span> = <code class="type">[ `Accepting of int * float | `Busy | `Shutting_down | `Starting of float ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>The container state for workload management:</p>
<ul>
<li><code class="code">`Accepting(n,t)</code>: The container is accepting further connections.
It currently processes <code class="code">n</code> connections. The last connection was
accepted at time <code class="code">t</code> (seconds since the epoch).</li>
<li><code class="code">`Busy</code>: The container does not accept connections</li>
<li><code class="code">`Starting t</code>: The container was started at time <code class="code">t</code> and is not
yet ready.</li>
<li><code class="code">`Shutting_down</code>: The container is being shutted down.</li>
</ul>
</div>
</div>
<pre><span id="TYPEcapacity"><span class="keyword">type</span> <code class="type"></code>capacity</span> = <code class="type">[ `Low_quality of int * bool | `Normal_quality of int * bool | `Unavailable ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>How many connections a container can accept in addition to the
existing connections:</p>
<ul>
<li><code class="code">`Normal_quality(n,greedy)</code>: It can accept n connections with normal
service quality, <code class="code">n > 0</code></li>
<li><code class="code">`Low_quality(n,greedy)</code>: It can accept n connections with low
service quality (e.g. because it is already quite loaded), <code class="code">n > 0</code></li>
<li><code class="code">`Unavailable</code>: No capacity free</li>
</ul>
<p>The <code class="code">greedy</code> flag sets whether greedy accepts are allowed.</p>
</div>
</div>
<pre><span id="TYPEextended_address"><span class="keyword">type</span> <code class="type"></code>extended_address</span> = <code class="type">[ `Container of<br> string * string * string * [ `Any | `Process of int | `Thread of int ]<br> | `Internal of string<br> | `Socket of Unix.sockaddr<br> | `Socket_file of string<br> | `W32_pipe of string<br> | `W32_pipe_file of string ]</code> </pre>
<div class="info ">
<div class="info-desc">
<p>Possible addresses:</p>
<ul>
<li><code class="code">`Socket s</code>: The socket at this socket address</li>
<li><code class="code">`Socket_file f</code>: The file <code class="code">f</code> contains the (anonymous) port number
of a socket bound to <code class="code">127.0.0.1</code> (This is meant as substitute for
Unix Domain sockets on Win32.)</li>
<li><code class="code">`W32_pipe name</code>: The Win32 pipe with this <code class="code">name</code> which must
be of the form "\\.\pipe\<pname>"</li>
<li><code class="code">`W32_pipe_file f</code>: The file <code class="code">f</code> contains the (random) name of a
Win32 pipe</li>
<li><code class="code">`Container(socket_dir,service_name,proto_name,thread_id)</code>:
The special endpoint
of the container for <code class="code">service_name</code> that is running as <code class="code">thread_id</code>.
It is system-dependent what this endpoint "is" in reality, usually
a socket or named pipe. If any container of a service is meant,
the value <code class="code">`Any</code> is substituted as a placeholder for a not yet
known <code class="code">thread_id</code>.</li>
<li><code class="code">`Internal name</code>: an internal service called <code class="code">name</code>. Internal sockets
are only available for multithreaded programs, and are registered
at <a href="Netplex_internal.html"><code class="code">Netplex_internal</code></a>.</li>
</ul>
</div>
</div>
<pre><code><span id="TYPEeq"><span class="keyword">type</span> <code class="type">('_, '_)</code> eq</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTeq.Equal"><span class="constructor">Equal</span></span> <span class="keyword">:</span> <code class="type">('a, 'a) <a href="Netplex_types.html#TYPEeq">eq</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTeq.Not_equal"><span class="constructor">Not_equal</span></span></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>Equality witness</p>
</div>
</div>
<pre><span id="TYPEpolysocket_kind"><span class="keyword">type</span> <code class="type">'_</code> polysocket_kind</span> = ..</pre>
<div class="info ">
<div class="info-desc">
<p>List possible argument types for polysockets (<a href="Netsys_polysocket.html"><code class="code">Netsys_polysocket</code></a>),
which are the basis for internal services. Since OCaml-4.02 this
type is extensible by the user.</p>
</div>
</div>
<pre><code><span class="keyword">type</span> <code class="type">'_</code> <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a> += </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="EXTENSIONTxdr">Txdr</span> <span class="keyword">:</span> <code class="type"><a href="Netxdr.html#TYPExdr_value">Netxdr.xdr_value</a> <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="EXTENSIONTstring">Tstring</span> <span class="keyword">:</span> <code class="type">string <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a></code></code></td>
</tr></table>
<pre><code><span id="TYPEkind_check"><span class="keyword">type</span> <code class="type">'a</code> kind_check</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind_check.kind_check">kind_check</span> : <code class="type">'b. 'b <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a> -> ('a, 'b) <a href="Netplex_types.html#TYPEeq">eq</a></code>;</code></td>
</tr></table>
}
<div class="info ">
<div class="info-desc">
<p>Helper type for a polymorphic check whether a kind this the expected
kind</p>
</div>
</div>
<pre><code><span id="TYPEpolysocket_kind_box"><span class="keyword">type</span> <code class="type"></code>polysocket_kind_box</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpolysocket_kind_box.Polysocket_kind_box"><span class="constructor">Polysocket_kind_box</span></span> <span class="keyword">:</span> <code class="type">'a <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a></code> <span class="keyword">-></span> <code class="type"><a href="Netplex_types.html#TYPEpolysocket_kind_box">polysocket_kind_box</a></code></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>Boxed version of <code class="code">polysocket_kind</code> where the type parameter is hidden</p>
</div>
</div>
<pre><code><span id="TYPEpolyserver_box"><span class="keyword">type</span> <code class="type"></code>polyserver_box</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpolyserver_box.Polyserver_box"><span class="constructor">Polyserver_box</span></span> <span class="keyword">:</span> <code class="type">'a <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a> * 'a <a href="Netsys_polysocket.html#TYPEpolyserver">Netsys_polysocket.polyserver</a></code> <span class="keyword">-></span> <code class="type"><a href="Netplex_types.html#TYPEpolyserver_box">polyserver_box</a></code></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>This type pairs a <code class="code">polysocket_kind</code> with a <code class="code">polyserver</code> as GADT. The
type parameter is hidden.</p>
</div>
</div>
<pre><code><span id="TYPEpolyclient_box"><span class="keyword">type</span> <code class="type"></code>polyclient_box</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTpolyclient_box.Polyclient_box"><span class="constructor">Polyclient_box</span></span> <span class="keyword">:</span> <code class="type">'a <a href="Netplex_types.html#TYPEpolysocket_kind">polysocket_kind</a> * 'a <a href="Netsys_polysocket.html#TYPEpolyclient">Netsys_polysocket.polyclient</a></code> <span class="keyword">-></span> <code class="type"><a href="Netplex_types.html#TYPEpolyclient_box">polyclient_box</a></code></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>This type pairs a <code class="code">polysocket_kind</code> with a <code class="code">polyclient</code>
as GADT. The type parameter is hidden.</p>
</div>
</div>
<pre><code><span id="TYPEextfd"><span class="keyword">type</span> <code class="type"></code>extfd</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTextfd.OS_descr"><span class="constructor">OS_descr</span></span> <span class="keyword">of</span> <code class="type">Unix.file_descr</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTextfd.Poly_endpoint"><span class="constructor">Poly_endpoint</span></span> <span class="keyword">of</span> <code class="type"><a href="Netxdr.html#TYPExdr_value">Netxdr.xdr_value</a> <a href="Netsys_polysocket.html#TYPEpolyendpoint">Netsys_polysocket.polyendpoint</a></code></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>Internally used</p>
</div>
</div>
<pre><span id="TYPEcontroller"><span class="keyword">class type</span> <a href="Netplex_types.controller-c.html">controller</a></span> = <code class="code">object</code> <a href="Netplex_types.controller-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>The controller is the object in the Netplex master process/thread
that manages the containers, logging, and service definitions</p>
</div>
<pre><span id="TYPEcontroller_config"><span class="keyword">class type</span> <a href="Netplex_types.controller_config-c.html">controller_config</a></span> = <code class="code">object</code> <a href="Netplex_types.controller_config-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEsocket_service"><span class="keyword">class type</span> <a href="Netplex_types.socket_service-c.html">socket_service</a></span> = <code class="code">object</code> <a href="Netplex_types.socket_service-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEsocket_service_config"><span class="keyword">class type</span> <a href="Netplex_types.socket_service_config-c.html">socket_service_config</a></span> = <code class="code">object</code> <a href="Netplex_types.socket_service_config-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEprotocol"><span class="keyword">class type</span> <a href="Netplex_types.protocol-c.html">protocol</a></span> = <code class="code">object</code> <a href="Netplex_types.protocol-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEsocket_controller"><span class="keyword">class type</span> <a href="Netplex_types.socket_controller-c.html">socket_controller</a></span> = <code class="code">object</code> <a href="Netplex_types.socket_controller-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEctrl_message_receiver"><span class="keyword">class type</span> <a href="Netplex_types.ctrl_message_receiver-c.html">ctrl_message_receiver</a></span> = <code class="code">object</code> <a href="Netplex_types.ctrl_message_receiver-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEprocessor_hooks"><span class="keyword">class type</span> <a href="Netplex_types.processor_hooks-c.html">processor_hooks</a></span> = <code class="code">object</code> <a href="Netplex_types.processor_hooks-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>Processor hooks can be used to modify the behavior of a processor.</p>
</div>
<pre><span id="TYPEprocessor"><span class="keyword">class type</span> <a href="Netplex_types.processor-c.html">processor</a></span> = <code class="code">object</code> <a href="Netplex_types.processor-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>The processor is the object that is notified when a new TCP connection
is accepted.</p>
</div>
<pre><span id="TYPEcontainer"><span class="keyword">class type</span> <a href="Netplex_types.container-c.html">container</a></span> = <code class="code">object</code> <a href="Netplex_types.container-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>Containers encapsulate the control flow of the service components.</p>
</div>
<pre><span id="TYPEworkload_manager"><span class="keyword">class type</span> <a href="Netplex_types.workload_manager-c.html">workload_manager</a></span> = <code class="code">object</code> <a href="Netplex_types.workload_manager-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>See <a href="Netplex_workload.html"><code class="code">Netplex_workload</code></a> for definitions of workload managers</p>
</div>
<pre><span id="TYPEplugin"><span class="keyword">class type</span> <a href="Netplex_types.plugin-c.html">plugin</a></span> = <code class="code">object</code> <a href="Netplex_types.plugin-c.html">..</a> <code class="code">end</code></pre><div class="info">
<p>Plugins are extensions of the Netplex system that run in the controller
and can be invoked from containers</p>
</div>
<pre><span id="TYPEpar_thread"><span class="keyword">class type</span> <a href="Netplex_types.par_thread-c.html">par_thread</a></span> = <code class="code">object</code> <a href="Netplex_types.par_thread-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEparallelizer"><span class="keyword">class type</span> <a href="Netplex_types.parallelizer-c.html">parallelizer</a></span> = <code class="code">object</code> <a href="Netplex_types.parallelizer-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEconfig_tree"><span class="keyword">type</span> <code class="type"></code>config_tree</span> = <code class="type">[ `Parameter of string * <a href="Netplex_types.html#TYPEparam_value">param_value</a><br> | `Section of string * <a href="Netplex_types.html#TYPEconfig_tree">config_tree</a> list ]</code> </pre>
<pre><span id="TYPEaddress"><span class="keyword">type</span> <code class="type"></code>address</span> = <</pre><table class="typetable">
</table>
>
</pre>
<pre><span id="TYPEconfig_file"><span class="keyword">class type</span> <a href="Netplex_types.config_file-c.html">config_file</a></span> = <code class="code">object</code> <a href="Netplex_types.config_file-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEprocessor_factory"><span class="keyword">class type</span> <a href="Netplex_types.processor_factory-c.html">processor_factory</a></span> = <code class="code">object</code> <a href="Netplex_types.processor_factory-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEworkload_manager_factory"><span class="keyword">class type</span> <a href="Netplex_types.workload_manager_factory-c.html">workload_manager_factory</a></span> = <code class="code">object</code> <a href="Netplex_types.workload_manager_factory-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPElogger_factory"><span class="keyword">class type</span> <a href="Netplex_types.logger_factory-c.html">logger_factory</a></span> = <code class="code">object</code> <a href="Netplex_types.logger_factory-c.html">..</a> <code class="code">end</code></pre>
<pre><span id="TYPEnetplex_config"><span class="keyword">class type</span> <a href="Netplex_types.netplex_config-c.html">netplex_config</a></span> = <code class="code">object</code> <a href="Netplex_types.netplex_config-c.html">..</a> <code class="code">end</code></pre></body></html>
|
