Added more comments.
[dyninst.git] / pdutil / docs / rpcUtil.1
1 .\"
2 .\" $Log: rpcUtil.1,v $
3 .\" Revision 1.2  1994/02/24 07:56:34  markc
4 .\" Added more comments.
5 .\"
6 .\"
7 .TH RPCUTIL 1L PARADYN "\\n(mo/\\n(dy/19\\n(yr"
8 .SH NAME
9 rpcUtil \- Support Library
10 .SH DESCRIPTION
11 .PP
12 This library provides utility functions.  It provides a list class, a hash table class, and functions to support client-server communications using XDR/pvm/threads.
13 .SH "LIST CLASS SYNOPSIS"
14 .B template <class Type> class List {
15 .br
16 .B      public:
17 .br
18 .B      List();
19 .br
20 .B      int  empty();
21 .br
22 .B      friend ostream &operator<<(ostream&, List<Type>&);
23 .br
24 .B      void print();
25 .br
26 .B      void add(Type data, void *key);
27 .br
28 .B      void add(Type data);
29 .br
30 .B      Boolean addUnique(Type data);
31 .br
32 .B      Boolean addUnique(Type data, void *key);
33 .br
34 .B      Type find(void *key);
35 .br
36 .B      Boolean remove(void *key);
37 .br
38 .B      int count();
39 .br
40 .B      Type operator *();
41 .br
42 .B      void operator +=(List<Type> mergee);
43 .br
44 .B      Type operator ++();
45 .br
46 .B      void map (void (*map_function)(const Type item));
47 .br
48 .B      void setCurrent();
49 .br
50 .B      const Type getCurrent();
51 .br
52 .B      const Type next();
53 .br
54 .B      void advanceCurrent();
55 .br
56 .B      protected:
57 .br
58 .B      ListItem<Type>  *head;
59 .br
60 .B      ListItem<Type>  *current;
61 .br
62 };
63 .br
64 .SH "HASH TABLE CLASS SYNOPSIS"
65 .PP
66 .B template <class Type> class HTable {
67 .br
68 .B    public:
69 .br
70 .B      friend ostream &operator<<(ostream&, HTable<Type>&);
71 .br
72 .B      void print();
73 .br
74 .B      HTable(Type data);
75 .br
76 .B      void add(Type data, void *key);
77 .br
78 .B      HTable(); 
79 .br
80 .B      Boolean addUnique(Type data, void *key);
81 .br
82 .B      Type find(void *key);
83 .br
84 .B      Boolean remove(void *key);
85 .br
86 .B      Type operator =(HTable<Type> arg);
87 .br
88 .B      Type operator *();
89 .br
90 .B      Type operator ++();
91 .br
92 .B      int count();
93 .br
94 .B      private:
95 .br
96 .B      List<Type> **table;
97 .br
98 .B      List<Type> currList;
99 .br
100 .B      int currHid;
101 .br
102 .B      int tableSize;
103 .br
104 };
105 .br
106 .SH "LIBRARY SYNOPSIS"
107 .TP 8
108 .B int RPCprocessCreate (pid, host, User, command, args)
109 .br
110 .B int *pid;
111 .br
112 .B char *host;  
113 .br
114 .B char *User;           
115 .br
116 .B char *command; 
117 .br
118 .B char **args;   
119 .TP 8
120 .B int RPC_readReady (fd)
121 .br
122 .B int fd;
123 .TP 8
124 .B int RPC_setup_socket (socket_fd, family, type)
125 .br
126 .B int *socket_fd;
127 .br
128 .B int family;
129 .br
130 .B int type;
131 .TP 8
132 .B char **RPC_make_arg_list (program, family, type,
133 .B                           port, flag)
134 .br
135 .B char *program;
136 .br
137 .B int family;
138 .br
139 .B int type;
140 .br
141 .B int port;
142 .br
143 .B int flag;
144 .TP 8
145 .B int RPC_undo_arg_list (argc, arg_list, machine,
146 .B                         family, type, socket, flag)
147 .br
148 .B int argc;
149 .br
150 .B char **arg_list;
151 .br
152 .B char **machine;
153 .br
154 .B int *family;
155 .br
156 .B int *type;
157 .br
158 .B int *socket;
159 .br
160 .B int *flag;
161 .TP 8
162 .B int RPC_getConnect (fd)
163 .br
164 .B int fd;
165
166 .SH "LIST CLASS DESCRIPTION"
167 .PP
168 .SH "HASH TABLE DESCRIPTION"
169 .PP
170 .SH "LIBRARY DESCRIPTION"
171 .PP
172 .SH "SEE ALSO"
173 Paradyn(1).
174 .SH COPYRIGHT
175 Copyright 1994, The Paradyn Software Team.
176 .SH AUTHOR
177 Mark Callaghan     (markc@cs.wisc.edu)
178
179
180