File: baseclasses.html

package info (click to toggle)
rudiments 0.31-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 7,516 kB
  • ctags: 3,248
  • sloc: asm: 23,776; cpp: 22,792; sh: 7,769; ansic: 1,769; makefile: 1,054; xml: 169; perl: 19
file content (709 lines) | stat: -rw-r--r-- 36,327 bytes parent folder | download | duplicates (2)
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
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
<html>
<head>
<title>firstworks   Programming with Rudiments using the Base Classes</title>
<link href="../css/styles.css" rel="stylesheet">
</head>
<body>

<span class="heading">Programming with Rudiments using the Base Classes</span><br><br>

<ul>
<li><a href="#daemon">Using the daemonprocess Class</a></li>
<li><a href="#file">Using the file Class</a></li>
<li><a href="#device">Using the device Class</a></li>
<li><a href="#serialport">Using the serialport Class</a></li>
<li><a href="#shmfile">Using the shmfile Class</a></li>
<li><a href="#server">Using the Server Classes</a></li>
<li><a href="#client">Using the Client Classes</a></li>
<li><a href="#complex">Using the Complex Initialization methods of the Server Classes</a></li>
<li><a href="#listener">Using the listener Class</a></li>
</ul>

<a name="daemon"></a>
<span class="heading">Using the daemonprocess Class</span><br><br>

<p>Here is some sample code for a daemon process that writes "hello" every 2
seconds.  Most daemons don't write anything to the console, but this one does
for purposes of demonstration.</p>








<pre>
<font color="#0000ff">// Copyright (c) 2001  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/daemonprocess.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/permissions.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/process.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/file.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/snooze.h&gt;</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdlib.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;sys/types.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;unistd.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

daemonprocess   *dmn;

<font color="#0000ff">// define a function to shut down the process cleanly</font>
RETSIGTYPE      shutDown() {

        printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%d</font><font color="#ff00ff">: shutting down</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,process::getProcessId());

        <font color="#0000ff">// clean up</font>
        <font color="#a52a2a"><b>delete</b></font> dmn;
        file::remove(<font color="#ff00ff">&quot;/tmp/dmn.pidfile&quot;</font>);
        exit(<font color="#ff00ff">0</font>);
}

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        dmn=<font color="#a52a2a"><b>new</b></font> daemonprocess();

        <font color="#0000ff">// set up signal handlers for clean shutdown</font>
        dmn-&gt;handleShutDown((RETSIGTYPE *)shutDown);
        dmn-&gt;handleCrash((RETSIGTYPE *)shutDown);

        <font color="#0000ff">// change the user/group that the daemon is running as</font>
        dmn-&gt;runAsUser(<font color="#ff00ff">&quot;nobody&quot;</font>);
        dmn-&gt;runAsGroup(<font color="#ff00ff">&quot;nobody&quot;</font>);

        <font color="#0000ff">// make sure that only one instance is running</font>
        <font color="#2e8b57"><b>int</b></font>    pid=dmn-&gt;checkForPidFile(<font color="#ff00ff">&quot;/tmp/dmn.pidfile&quot;</font>);
        <font color="#a52a2a"><b>if</b></font> (pid&gt;-<font color="#ff00ff">1</font>) {
                printf(<font color="#ff00ff">&quot;Sorry, an instance of this daemon is already running with process id: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,pid);
                <font color="#a52a2a"><b>delete</b></font> dmn;
                exit(<font color="#ff00ff">0</font>);
        }

        <font color="#0000ff">// detach from the controlling terminal</font>
        dmn-&gt;detach();

        <font color="#0000ff">// create a pid file which is used to make sure that only one instance</font>
        <font color="#0000ff">// is running and can also be used to kill the process</font>
        dmn-&gt;createPidFile(<font color="#ff00ff">&quot;/tmp/dmn.pidfile&quot;</font>,permissions::ownerReadWrite());

        <font color="#a52a2a"><b>if</b></font> (!fork()) {
                <font color="#a52a2a"><b>for</b></font> (;;) {
                        printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%d</font><font color="#ff00ff">: child looping...</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,
                                process::getProcessId());
                        snooze::macrosnooze(<font color="#ff00ff">1</font>);
                }
        }

        <font color="#0000ff">// loop, printing &quot;looping...&quot; once per second</font>
        <font color="#a52a2a"><b>for</b></font> (;;) {
                printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%d</font><font color="#ff00ff">: parent looping...</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,
                                process::getProcessId());
                snooze::macrosnooze(<font color="#ff00ff">1</font>);
        }
}
</pre>



<a name="file">
<span class="heading">Using the file Class</span><br><br>

<p>...</p>








<pre>
<font color="#0000ff">// Copyright (c) 2003  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/groupentry.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/passwdentry.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/file.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/permissions.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/datetime.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {


        <font color="#0000ff">// remove the file (in case it already exists)</font>
        file::remove(<font color="#ff00ff">&quot;testfile&quot;</font>);


        <font color="#0000ff">// create a new file called &quot;testfile&quot; with rw-rw---- permissions</font>
        <font color="#0000ff">// and initial contents &quot;hello&quot;</font>
        file    fl;
        fl.create(<font color="#ff00ff">&quot;testfile&quot;</font>,permissions::evalPermString(<font color="#ff00ff">&quot;rw-rw----&quot;</font>),<font color="#ff00ff">&quot;hello&quot;</font>);

        printf(<font color="#ff00ff">&quot;testfile:</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);

        <font color="#0000ff">// check for existence</font>
        <font color="#a52a2a"><b>if</b></font> (file::exists(<font color="#ff00ff">&quot;testfile&quot;</font>)) {
                printf(<font color="#ff00ff">&quot;      exists</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        } <font color="#a52a2a"><b>else</b></font> {
                printf(<font color="#ff00ff">&quot;      does not exist</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        }

        <font color="#0000ff">// display the permissions of the file</font>
        mode_t  mode=fl.getPermissions();
        printf(<font color="#ff00ff">&quot;       permissions: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,permissions::evalPermOctal(mode));


        <font color="#0000ff">// display the name of the user that owns the file</font>
        uid_t   uid=fl.getOwnerUserId();
        <font color="#2e8b57"><b>char</b></font>   *username;
        passwdentry::getName(uid,&amp;username);
        printf(<font color="#ff00ff">&quot;       user       : </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,username);
        <font color="#a52a2a"><b>delete</b></font>[] username;


        <font color="#0000ff">// display the name of the group that owns the file</font>
        gid_t   gid=fl.getOwnerGroupId();
        <font color="#2e8b57"><b>char</b></font>   *groupname;
        groupentry::getName(gid,&amp;groupname);
        printf(<font color="#ff00ff">&quot;       group      : </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,groupname);
        <font color="#a52a2a"><b>delete</b></font>[] groupname;


        <font color="#0000ff">// display the size of the file in bytes</font>
        off64_t size=fl.getSize();
        printf(<font color="#ff00ff">&quot;       size       : </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,size);


        <font color="#0000ff">// display the size of the file in blocks</font>
        blkcnt_t        blocks=fl.getBlockCount();
        printf(<font color="#ff00ff">&quot;       blocks     : </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,blocks);


        <font color="#0000ff">// display the file type</font>
        printf(<font color="#ff00ff">&quot;       is a socket: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isSocket());
        printf(<font color="#ff00ff">&quot;       is a symlink: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isSymbolicLink());
        printf(<font color="#ff00ff">&quot;       is a regular file: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isRegularFile());
        printf(<font color="#ff00ff">&quot;       is a block device: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isBlockDevice());
        printf(<font color="#ff00ff">&quot;       is a directory: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isDirectory());
        printf(<font color="#ff00ff">&quot;       is a character device: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isCharacterDevice());
        printf(<font color="#ff00ff">&quot;       is a fifo: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,fl.isFifo());


        <font color="#0000ff">// display the last time the file was accessed</font>
        <font color="#2e8b57"><b>time_t</b></font> atime=fl.getLastAccessTime();
        <font color="#2e8b57"><b>char</b></font>   *atimestr=datetime::getString(atime);
        printf(<font color="#ff00ff">&quot;       last access      : </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,atimestr);
        <font color="#a52a2a"><b>delete</b></font>[] atimestr;


        <font color="#0000ff">// display the last time the file was modified</font>
        <font color="#2e8b57"><b>time_t</b></font> mtime=fl.getLastModificationTime();
        <font color="#2e8b57"><b>char</b></font>   *mtimestr=datetime::getString(mtime);
        printf(<font color="#ff00ff">&quot;       last modification: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,mtimestr);
        <font color="#a52a2a"><b>delete</b></font>[] mtimestr;


        <font color="#0000ff">// display the last time the file was changed</font>
        <font color="#2e8b57"><b>time_t</b></font> ctime=fl.getLastChangeTime();
        <font color="#2e8b57"><b>char</b></font>   *ctimestr=datetime::getString(ctime);
        printf(<font color="#ff00ff">&quot;       last change      : </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,ctimestr);
        <font color="#a52a2a"><b>delete</b></font>[] ctimestr;


        <font color="#0000ff">// display the device that the file resides on</font>
        dev_t   dev=fl.getDevice();
        printf(<font color="#ff00ff">&quot;       device           : </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,dev);


        <font color="#0000ff">// display the type of the device that the file resides on</font>
        dev_t   devtype=fl.getDeviceType();
        printf(<font color="#ff00ff">&quot;       device type      : </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,devtype);


        <font color="#0000ff">// display the file's first inode</font>
        ino_t   inode=fl.getInode();
        printf(<font color="#ff00ff">&quot;       inode            : </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,inode);


        <font color="#0000ff">// display the number of hard links to the file</font>
        nlink_t nlink=fl.getNumberOfHardLinks();
        printf(<font color="#ff00ff">&quot;       hard links : </font><font color="#6a5acd">%ld</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,nlink);


        <font color="#2e8b57"><b>char</b></font>   *path=<font color="#ff00ff">&quot;/usr/local/firstworks/include/rudiments/file.h&quot;</font>;
        <font color="#2e8b57"><b>char</b></font>   *dirname=file::dirname(path);
        printf(<font color="#ff00ff">&quot;dirname(</font><font color="#6a5acd">%s</font><font color="#ff00ff">)=</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,path,dirname);
        <font color="#a52a2a"><b>delete</b></font>[] dirname;

        <font color="#2e8b57"><b>char</b></font>   *basename=file::basename(path);
        printf(<font color="#ff00ff">&quot;basename(</font><font color="#6a5acd">%s</font><font color="#ff00ff">)=</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,path,basename);
        <font color="#a52a2a"><b>delete</b></font>[] basename;

        basename=file::basename(path,<font color="#ff00ff">&quot;.h&quot;</font>);
        printf(<font color="#ff00ff">&quot;basename(</font><font color="#6a5acd">%s</font><font color="#ff00ff">,</font><font color="#6a5acd">\&quot;</font><font color="#ff00ff">.h</font><font color="#6a5acd">\&quot;</font><font color="#ff00ff">)=</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,path,basename);
        <font color="#a52a2a"><b>delete</b></font>[] basename;

        printf(<font color="#ff00ff">&quot;key=</font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,file::generateKey(<font color="#ff00ff">&quot;/&quot;</font>,<font color="#ff00ff">1</font>));

        printf(<font color="#ff00ff">&quot;maxLinks(</font><font color="#6a5acd">%s</font><font color="#ff00ff">)=</font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,path,file::maxLinks(path));

        printf(<font color="#ff00ff">&quot;canChangeOwner(</font><font color="#6a5acd">%s</font><font color="#ff00ff">)=</font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,path,file::canChangeOwner(path));
}
</pre>



<a name="device">
<span class="heading">Using the device Class</span><br><br>

<p>...</p>








<pre>
<font color="#0000ff">// Copyright (c) 2003  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        <font color="#0000ff">// </font><span style="background-color: #ffff00"><font color="#0000ff">FIXME</font></span><font color="#0000ff">: implement this...</font>
}
</pre>



<a name="serialport">
<span class="heading">Using the serialport Class</span><br><br>

<p>...</p>








<pre>
<font color="#0000ff">// Copyright (c) 2003  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        <font color="#0000ff">// </font><span style="background-color: #ffff00"><font color="#0000ff">FIXME</font></span><font color="#0000ff">: implement this...</font>
}
</pre>



<a name="shmfile">
<span class="heading">Using the shmfile Class</span><br><br>

<p>...</p>








<pre>
<font color="#0000ff">// Copyright (c) 2003  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        <font color="#0000ff">// </font><span style="background-color: #ffff00"><font color="#0000ff">FIXME</font></span><font color="#0000ff">: implement this...</font>
}
</pre>



<a name="server"></a>
<span class="heading">Using the Server Classes</span><br><br>

<p>Daemons are commonly used to serve data to clients on the same machine or
over a network.  Below is an example combining the daemon and listener classes.
This server listens on unix and inet sockets for a client connection, receives
a string from the client and writes the same string back to the client.</p>








<pre>
<font color="#0000ff">// Copyright (c) 2001  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/daemonprocess.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/permissions.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/inetserversocket.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/file.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>class</b></font> myserver : <font color="#a52a2a"><b>public</b></font> daemonprocess, <font color="#a52a2a"><b>public</b></font> inetserversocket {
        <font color="#a52a2a"><b>public</b></font>:
                        myserver() : daemonprocess(), inetserversocket() {}
                <font color="#2e8b57"><b>void</b></font>  listen();
};


<font color="#2e8b57"><b>void</b></font>    myserver::listen() {


        <font color="#0000ff">// make sure that only one instance is running</font>
        <font color="#2e8b57"><b>int</b></font>    pid=checkForPidFile(<font color="#ff00ff">&quot;/tmp/svr.pidfile&quot;</font>);
        <font color="#a52a2a"><b>if</b></font> (pid&gt;-<font color="#ff00ff">1</font>) {
                printf(<font color="#ff00ff">&quot;Sorry, an instance of this server is already running with process id: </font><font color="#6a5acd">%d</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,pid);
                <font color="#a52a2a"><b>return</b></font>;
        }


        <font color="#0000ff">// detach from the controlling terminal</font>
        <font color="#0000ff">//detach();</font>


        <font color="#0000ff">// create a pid file which is used to make sure that only one instance</font>
        <font color="#0000ff">// is running and can also be used to kill the process</font>
        createPidFile(<font color="#ff00ff">&quot;/tmp/svr.pidfile&quot;</font>,permissions::ownerReadWrite());


        <font color="#0000ff">// listen on inet socket port 8000</font>
        <font color="#a52a2a"><b>if</b></font> (!inetserversocket::listen(<font color="#ff00ff">NULL</font>,<font color="#ff00ff">8000</font>,<font color="#ff00ff">15</font>)) {
                printf(<font color="#ff00ff">&quot;couldn't listen on port 8000</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        }


        <font color="#0000ff">// loop...</font>
        <font color="#a52a2a"><b>for</b></font> (;;) {

                <font color="#0000ff">// accept a client connection</font>
                filedescriptor  *clientsock=accept();

                <font color="#0000ff">// read 5 bytes from the client and display it</font>
                <font color="#2e8b57"><b>char</b></font>  buffer[<font color="#ff00ff">6</font>];
                buffer[<font color="#ff00ff">5</font>]=(<font color="#2e8b57"><b>char</b></font>)<font color="#ff00ff">NULL</font>;
                clientsock-&gt;read((<font color="#2e8b57"><b>char</b></font> *)buffer,<font color="#ff00ff">5</font>);
                printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,buffer);

                <font color="#0000ff">// write &quot;hello&quot; back to the client</font>
                clientsock-&gt;write(<font color="#ff00ff">&quot;hello&quot;</font>,<font color="#ff00ff">5</font>);

                <font color="#0000ff">// close the socket and clean up</font>
                clientsock-&gt;close();
                <font color="#a52a2a"><b>delete</b></font> clientsock;
        }
}


myserver        *mysvr;

<font color="#0000ff">// define a function to shut down the process cleanly</font>
RETSIGTYPE      shutDown() {
        printf(<font color="#ff00ff">&quot;shutting down</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        mysvr-&gt;close();
        <font color="#a52a2a"><b>delete</b></font> mysvr;
        file::remove(<font color="#ff00ff">&quot;/tmp/svr.pidfile&quot;</font>);
        exit(<font color="#ff00ff">0</font>);
}


<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        mysvr=<font color="#a52a2a"><b>new</b></font> myserver();

        <font color="#0000ff">// set up signal handlers for clean shutdown</font>
        mysvr-&gt;handleShutDown((RETSIGTYPE *)shutDown);
        mysvr-&gt;handleCrash((RETSIGTYPE *)shutDown);

        mysvr-&gt;listen();
}
</pre>



<p>Notice that this server listens on both inet and unix ports.  Inet ports
allow clients and servers to talk across a network.  Unix ports allow clients
and servers on the same machine to talk through a pipe.  Though clients and
servers on the same machine could talk over inet ports, unix ports are much
faster and use fewer system resources.</p>

<a name="client"></a>
<span class="heading">Using the Client Classes</span><br><br>

<p>Here's the code for a client that can talk to the server above.  This client
sends a string to the server, reads what the server sends back and prints it
out.  It does this once over an inet port and once over a unix port.</p>








<pre>
<font color="#0000ff">// Copyright (c) 2001  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/inetclientsocket.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/error.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        <font color="#0000ff">// create an inet socket client</font>
        inetclientsocket        clnt;

        <font color="#0000ff">// connect to a server on localhost, listening on port 8000</font>
        <font color="#a52a2a"><b>if</b></font> (clnt.connect(<font color="#ff00ff">&quot;localhost&quot;</font>,<font color="#ff00ff">8000</font>,-<font color="#ff00ff">1</font>,-<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>)&lt;<font color="#ff00ff">0</font>) {
                printf(<font color="#ff00ff">&quot;connect failed: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,error::getErrorString());
                exit(<font color="#ff00ff">1</font>);
        }

        <font color="#0000ff">// write &quot;hello&quot; to the server</font>
        clnt.write(<font color="#ff00ff">&quot;hello&quot;</font>,<font color="#ff00ff">5</font>);

        <font color="#0000ff">// read 10 bytes from the server and display them</font>
        <font color="#2e8b57"><b>char</b></font>   buffer[<font color="#ff00ff">11</font>];
        <font color="#2e8b57"><b>int</b></font>    sizeread=clnt.read(buffer,<font color="#ff00ff">10</font>);
        buffer[sizeread]=(<font color="#2e8b57"><b>char</b></font>)<font color="#ff00ff">NULL</font>;
        printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,buffer);

        <font color="#0000ff">// close the connection to the server</font>
        clnt.close();
}
</pre>










<pre>
<font color="#0000ff">// Copyright (c) 2001  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/unixclientsocket.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/error.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {

        <font color="#0000ff">// create a unix socket client</font>
        unixclientsocket        clnt;

        <font color="#0000ff">// connect to a server listening on /tmp/lsnr.socket</font>
        <font color="#a52a2a"><b>if</b></font> (clnt.connect(<font color="#ff00ff">&quot;/tmp/lsnr.socket&quot;</font>,-<font color="#ff00ff">1</font>,-<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>,<font color="#ff00ff">1</font>)&lt;<font color="#ff00ff">0</font>) {
                printf(<font color="#ff00ff">&quot;connect failed: </font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,error::getErrorString());
                exit(<font color="#ff00ff">0</font>);
        }

        <font color="#0000ff">// write &quot;hello&quot; to the server</font>
        clnt.write(<font color="#ff00ff">&quot;hello&quot;</font>,<font color="#ff00ff">5</font>);

        <font color="#0000ff">// read 10 bytes from the server and display them</font>
        <font color="#2e8b57"><b>char</b></font>   buffer[<font color="#ff00ff">11</font>];
        <font color="#2e8b57"><b>int</b></font>    sizeread=clnt.read(buffer,<font color="#ff00ff">10</font>);
        buffer[sizeread]=(<font color="#2e8b57"><b>char</b></font>)<font color="#ff00ff">NULL</font>;
        printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,buffer);

        <font color="#0000ff">// close the connection to the server</font>
        clnt.close();
}
</pre>



<a name="complex"></a>
<span class="heading">Using the Complex Initialization methods of the
Server Classes</span><br><br>

<p>Setting up a server to listen on a socket is actually a multi-step process. 
The listen() methods simplify this process but some applications may
require a more flexible interface.  If you need to set socket options or
perform additional actions between the steps of socket initialization, you can
use the Complex Inititalization methods of the server classes.</p>

<p>Below is an alternative implementation of the myserver constructor in
which some socket options are set.</p>

<pre>
myserver::myserver() : daemonprocess(), listener() {

        <font color="#0000ff">// run as a different user/group</font>
        runAsUser(<font color="#ff00ff">&quot;nobody&quot;</font>);
        runAsGroup(<font color="#ff00ff">&quot;nobody&quot;</font>);

        <font color="#0000ff">// detach from the controlling tty</font>
        detach();

        <font color="#0000ff">// initialize the ports</font>
        inetsocket.initialize(<font color="#ff00ff">NULL</font>,<font color="#ff00ff">8040</font>);
        unixsocket.initialize(<font color="#ff00ff">&quot;/tmp/mysocket&quot;</font>,S_IRUSR|S_IWUSR);

        <font color="#0000ff">// set some socket options</font>
        inetsocket.lingerOnClose(<font color="#ff00ff">10</font>);
        inetsocket.reuseAddresses();
        unixsocket.lingerOnClose(<font color="#ff00ff">10</font>);

        <font color="#0000ff">// bind to the ports</font>
        inetsocket.bind();
        unixsocket.bind();

        <font color="#0000ff">// listen on the ports</font>
        inetsocket.listen(<font color="#ff00ff">15</font>);
        unixsocket.listen(<font color="#ff00ff">15</font>);

        <font color="#0000ff">// add sockets to the pool</font>
        addFileDescriptor(&amp;inetsocket);
        addFileDescriptor(&amp;unixsocket);
}
</pre>

<a name="listener">
<span class="heading">Using the listener Class</span><br><br>

<p>...</p>








<pre>
<font color="#0000ff">// Copyright (c) 2001  David Muse</font>
<font color="#0000ff">// See the file COPYING for more information</font>

<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/listener.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/inetserversocket.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/unixserversocket.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;rudiments/permissions.h&gt;</font>
<font color="#a020f0">#include </font><font color="#ff00ff">&lt;stdio.h&gt;</font>

<font color="#a020f0">#ifdef RUDIMENTS_NAMESPACE</font>
<font color="#a52a2a"><b>using</b></font> <font color="#2e8b57"><b>namespace</b></font> rudiments;
<font color="#a020f0">#endif</font>

<font color="#2e8b57"><b>int</b></font> main(<font color="#2e8b57"><b>int</b></font> argc, <font color="#2e8b57"><b>const</b></font> <font color="#2e8b57"><b>char</b></font> **argv) {


        <font color="#0000ff">// listen on inet socket port 1800</font>
        inetserversocket        inetsock;
        <font color="#a52a2a"><b>if</b></font> (!inetsock.listen(<font color="#ff00ff">NULL</font>,<font color="#ff00ff">8000</font>,<font color="#ff00ff">15</font>)) {
                printf(<font color="#ff00ff">&quot;couldn't listen on inet socket</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        }


        <font color="#0000ff">// listen on unix socket &quot;/tmp/lsnr.socket&quot;</font>
        unixserversocket        unixsock;
        <font color="#a52a2a"><b>if</b></font> (!unixsock.listen(<font color="#ff00ff">&quot;/tmp/lsnr.socket&quot;</font>,<font color="#a020f0">0</font><font color="#ff00ff">000</font>,<font color="#ff00ff">15</font>)) {
                printf(<font color="#ff00ff">&quot;couldn't listen on unix socket</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
        }


        <font color="#0000ff">// create a listener and add the 2 sockets to it</font>
        listener        pool;
        pool.addFileDescriptor(&amp;inetsock);
        pool.addFileDescriptor(&amp;unixsock);


        <font color="#0000ff">// loop...</font>
        <font color="#a52a2a"><b>for</b></font> (;;) {

                <font color="#0000ff">// wait for a client to connect to one of the sockets</font>
                pool.waitForNonBlockingRead(-<font color="#ff00ff">1</font>,-<font color="#ff00ff">1</font>);
                filedescriptor  *fd=<font color="#ff00ff">NULL</font>;
                pool.getReadyList()-&gt;getDataByIndex(<font color="#ff00ff">0</font>,&amp;fd);

                <font color="#0000ff">// figure out which socket the client connected to</font>
                filedescriptor  *clientsock;
                <font color="#a52a2a"><b>if</b></font> (fd==&amp;inetsock) {
                        clientsock=inetsock.accept();
                        printf(<font color="#ff00ff">&quot;inetsock: &quot;</font>);
                } <font color="#a52a2a"><b>else</b></font> <font color="#a52a2a"><b>if</b></font> (fd==&amp;unixsock) {
                        clientsock=unixsock.accept();
                        printf(<font color="#ff00ff">&quot;unixsock: &quot;</font>);
                } <font color="#a52a2a"><b>else</b></font> {
                        printf(<font color="#ff00ff">&quot;error or timeout waiting...</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>);
                        <font color="#a52a2a"><b>continue</b></font>;
                }


                <font color="#0000ff">// read 5 bytes from the client and display it</font>
                <font color="#2e8b57"><b>char</b></font>  buffer[<font color="#ff00ff">6</font>];
                buffer[<font color="#ff00ff">5</font>]=(<font color="#2e8b57"><b>char</b></font>)<font color="#ff00ff">NULL</font>;
                clientsock-&gt;read(buffer,<font color="#ff00ff">5</font>);
                printf(<font color="#ff00ff">&quot;</font><font color="#6a5acd">%s</font><font color="#6a5acd">\n</font><font color="#ff00ff">&quot;</font>,buffer);


                <font color="#0000ff">// write &quot;hello&quot; back to the client</font>
                clientsock-&gt;write(<font color="#ff00ff">&quot;hello&quot;</font>,<font color="#ff00ff">5</font>);


                <font color="#0000ff">// close the socket and clean up</font>
                clientsock-&gt;close();
                <font color="#a52a2a"><b>delete</b></font> clientsock;
        }
}
</pre>



</body>
</html>