File: protocolentry.h.html

package info (click to toggle)
librudiments0 0.27-3
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,528 kB
  • ctags: 2,284
  • sloc: cpp: 14,657; sh: 7,547; ansic: 2,664; makefile: 945; xml: 15
file content (76 lines) | stat: -rw-r--r-- 5,267 bytes parent folder | download 
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
 
<html>
<head>
<title>~/src/firstworks/rudiments-0.27/include/rudiments/protocolentry.h.html</title>
<meta name="Generator" content="Vim/6.2">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff" text="#000000">
<pre>
<font color="#0000ff">// Copyright (c) 2002 David Muse</font>
<font color="#0000ff">// See the COPYING file for more information.</font>

<font color="#a520f7">#ifndef RUDIMENTS_PROTOCOLENTRY_H</font>
<font color="#a520f7">#define RUDIMENTS_PROTOCOLENTRY_H</font>

<font color="#a520f7">#include </font><font color="#ff00ff">&lt;rudiments/private/protocolentryincludes.h&gt;</font>

<font color="#0000ff">// The protocolentry class provides methods for retrieving</font>
<font color="#0000ff">// entries from /etc/protocols</font>

<font color="#298a52"><b>class</b></font> protocolentry {
        <font color="#a52829"><b>public</b></font>:

                <font color="#0000ff">// If you need to quickly look up a specific field, use one of</font>
                <font color="#0000ff">// these methods.</font>
                <font color="#0000ff">//</font>
                <font color="#0000ff">// These methods return true on success and false on failure.</font>
                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>bool</b></font>    getAliasList(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *protocolname,
                                                <font color="#298a52"><b>char</b></font> ***aliaslist);
                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>bool</b></font>    getNumber(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *protocolname,
                                                <font color="#298a52"><b>int</b></font> *number);

                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>bool</b></font>    getName(<font color="#298a52"><b>int</b></font> number, <font color="#298a52"><b>char</b></font> **name);
                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>bool</b></font>    getAliasList(<font color="#298a52"><b>int</b></font> number, <font color="#298a52"><b>char</b></font> ***aliaslist);


                <font color="#0000ff">// If you need to look up a protocol entry and refer to multiple</font>
                <font color="#0000ff">// fields, use these methods.</font>
                        protocolentry();
                        ~protocolentry();

                <font color="#298a52"><b>bool</b></font>    initialize(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *protocolname);
                        <font color="#0000ff">// Looks up a protocol entry by name.</font>
                        <font color="#0000ff">// Returns true on success and false on failure.</font>
                <font color="#298a52"><b>bool</b></font>    initialize(<font color="#298a52"><b>int</b></font> number);
                        <font color="#0000ff">// Looks up a protocol entry by number.</font>
                        <font color="#0000ff">// Returns true on success and false on failure.</font>

                <font color="#298a52"><b>char</b></font>    *getName() <font color="#298a52"><b>const</b></font>;
                <font color="#298a52"><b>char</b></font>    **getAliasList() <font color="#298a52"><b>const</b></font>;
                <font color="#298a52"><b>int</b></font>     getNumber() <font color="#298a52"><b>const</b></font>;

                <font color="#298a52"><b>void</b></font>    print() <font color="#298a52"><b>const</b></font>;
                        <font color="#0000ff">// Prints out the protocol entry.</font>

<font color="#a520f7">#ifdef RUDIMENTS_HAS_THREADS</font>
                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>bool</b></font>    needsMutex();
                        <font color="#0000ff">// If your system doesn't support getprotobyname_r()</font>
                        <font color="#0000ff">// and getprotobynumber_r() then this class needs a</font>
                        <font color="#0000ff">// mutex to assure thread safety.</font>
                        <font color="#0000ff">//</font>
                        <font color="#0000ff">// This method returns true if this class needs a mutex</font>
                        <font color="#0000ff">// to operate safely in a threaded environment and false</font>
                        <font color="#0000ff">// otherwise.</font>
                <font color="#298a52"><b>static</b></font>  <font color="#298a52"><b>void</b></font>    setMutex(pthread_mutex_t *mutex);
                        <font color="#0000ff">// Allows you to supply a mutex is the class needs it.</font>
                        <font color="#0000ff">// If your application is not multithreaded, then</font>
                        <font color="#0000ff">// there is no need to supply a mutex.</font>
<font color="#a520f7">#endif</font>

<font color="#a520f7">        #include </font><font color="#ff00ff">&lt;rudiments/private/protocolentry.h&gt;</font>
};

<font color="#a520f7">#endif</font>
</pre>
</body>
</html>