Extended man page.
[dyninst.git] / common / docs / rpcUtil.1
1 .\"
2 .\" $Log: rpcUtil.1,v $
3 .\" Revision 1.3  1994/02/24 20:54:28  markc
4 .\" Extended man page.
5 .\"
6 # Revision 1.2  1994/02/24  07:56:34  markc
7 # Added more comments.
8 #
9 .\"
10 .TH RPCUTIL 1L PARADYN "\\n(mo/\\n(dy/19\\n(yr"
11 .SH NAME
12 rpcUtil \- Support Library
13 .SH DESCRIPTION
14 .PP
15 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.
16 .SH "LIST CLASS SYNOPSIS"
17 .B template <class Type> class List {
18 .br
19 .B      public:
20 .br
21 .B      List();
22 .br
23 .B      int  empty();
24 .br
25 .B      friend ostream &operator<<(ostream&, List<Type>&);
26 .br
27 .B      void print();
28 .br
29 .B      void add(Type data, void *key);
30 .br
31 .B      void add(Type data);
32 .br
33 .B      Boolean addUnique(Type data);
34 .br
35 .B      Boolean addUnique(Type data, void *key);
36 .br
37 .B      Type find(void *key);
38 .br
39 .B      Boolean remove(void *key);
40 .br
41 .B      int count();
42 .br
43 .B      Type operator *();
44 .br
45 .B      void operator +=(List<Type> mergee);
46 .br
47 .B      Type operator ++();
48 .br
49 .B      void map (void (*map_function)(const Type item));
50 .br
51 .B      void setCurrent();
52 .br
53 .B      const Type getCurrent();
54 .br
55 .B      const Type next();
56 .br
57 .B      void advanceCurrent();
58 .br
59 .B      protected:
60 .br
61 .B      ListItem<Type>  *head;
62 .br
63 .B      ListItem<Type>  *current;
64 .br
65 };
66 .br
67 .SH "HASH TABLE CLASS SYNOPSIS"
68 .PP
69 .B template <class Type> class HTable {
70 .br
71 .B    public:
72 .br
73 .B      friend ostream &operator<<(ostream&, HTable<Type>&);
74 .br
75 .B      void print();
76 .br
77 .B      HTable(Type data);
78 .br
79 .B      void add(Type data, void *key);
80 .br
81 .B      HTable(); 
82 .br
83 .B      Boolean addUnique(Type data, void *key);
84 .br
85 .B      Type find(void *key);
86 .br
87 .B      Boolean remove(void *key);
88 .br
89 .B      Type operator =(HTable<Type> arg);
90 .br
91 .B      Type operator *();
92 .br
93 .B      Type operator ++();
94 .br
95 .B      int count();
96 .br
97 .B      private:
98 .br
99 .B      List<Type> **table;
100 .br
101 .B      List<Type> currList;
102 .br
103 .B      int currHid;
104 .br
105 .B      int tableSize;
106 .br
107 };
108 .br
109 .SH "LIBRARY SYNOPSIS"
110 .TP 8
111 .B int RPCprocessCreate (pid, host, User, command,
112 .B       args)
113 .br
114 .B int *pid;
115 .br
116 .B char *host;  
117 .br
118 .B char *User;           
119 .br
120 .B char *command; 
121 .br
122 .B char **args;   
123 .TP 8
124 .B int RPC_readReady (fd)
125 .br
126 .B int fd;
127 .TP 8
128 .B int RPC_setup_socket (socket_fd, family, type)
129 .br
130 .B int *socket_fd;
131 .br
132 .B int family;
133 .br
134 .B int type;
135 .TP 8
136 .B char **RPC_make_arg_list (program, family, type,
137 .B                           port, flag)
138 .br
139 .B char *program;
140 .br
141 .B int family;
142 .br
143 .B int type;
144 .br
145 .B int port;
146 .br
147 .B int flag;
148 .TP 8
149 .B int RPC_undo_arg_list (argc, arg_list, machine,
150 .B                         family, type, socket, flag)
151 .br
152 .B int argc;
153 .br
154 .B char **arg_list;
155 .br
156 .B char **machine;
157 .br
158 .B int *family;
159 .br
160 .B int *type;
161 .br
162 .B int *socket;
163 .br
164 .B int *flag;
165 .TP 8
166 .B int RPC_getConnect (fd)
167 .br
168 .B int fd;
169
170 .SH "LIST CLASS DESCRIPTION"
171 .PP
172 .SH "HASH TABLE DESCRIPTION"
173 .PP
174 .SH "LIBRARY DESCRIPTION"
175 .PP
176 .B int RPCprocessCreate (pid, host, User, command,
177 .B       args)
178 .br
179 .B int *pid;
180 .br
181 .B char *host;  
182 .br
183 .B char *User;           
184 .br
185 .B char *command; 
186 .br
187 .B char **args;   
188 .br
189 stdout will be closed for the exec'd program.  The pid is returned in pid.
190 Host is the name of the host to start the program on.  Command is the name
191 of the command to exec.  If args is non-null, it will be used as an argument 
192 for the exec.  Thus, command should be the first entry in args.  If args is
193 null, command is passed as the argument list.
194 .TP 8
195 .B int RPC_readReady (fd)
196 .br
197 .B int fd;
198 .TP 8
199 .B int RPC_setup_socket (socket_fd, family, type)
200 .br
201 .B int *socket_fd;
202 .br
203 .B int family;
204 .br
205 .B int type;
206 .TP 8
207 .B char **RPC_make_arg_list (program, family, type,
208 .B                           port, flag)
209 .br
210 .B char *program;
211 .br
212 .B int family;
213 .br
214 .B int type;
215 .br
216 .B int port;
217 .br
218 .B int flag;
219 .TP 8
220 .B int RPC_undo_arg_list (argc, arg_list, machine,
221 .B                         family, type, socket, flag)
222 .br
223 .B int argc;
224 .br
225 .B char **arg_list;
226 .br
227 .B char **machine;
228 .br
229 .B int *family;
230 .br
231 .B int *type;
232 .br
233 .B int *socket;
234 .br
235 .B int *flag;
236 .TP 8
237 .B int RPC_getConnect (fd)
238 .br
239 .B int fd;
240
241 .SH "SEE ALSO"
242 Paradyn(1).
243 .SH COPYRIGHT
244 Copyright 1994, The Paradyn Software Team.
245 .SH AUTHOR
246 Mark Callaghan     (markc@cs.wisc.edu)
247
248
249