cctools
link.h
Go to the documentation of this file.
1 /*
2 Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
3 Copyright (C) 2005- The University of Notre Dame
4 This software is distributed under the GNU General Public License.
5 See the file COPYING for details.
6 */
7 
8 #ifndef LINK_H
9 #define LINK_H
10 
44 #include <sys/types.h>
45 
46 #include <limits.h>
47 #include <signal.h>
48 #include <stdarg.h>
49 #include <stdint.h>
50 #include <stdio.h>
51 #include <time.h>
52 
54 #define LINK_ADDRESS_MAX 48
55 
57 #define LINK_PORT_ANY 0
58 
60 #define LINK_FOREVER ((time_t)INT_MAX)
61 #define LINK_NOWAIT ((time_t)INT_MIN)
62 
69 struct link *link_connect(const char *addr, int port, time_t stoptime);
70 
75 int link_ssl_wrap_connect(struct link *link);
76 
81 struct link *link_attach_to_file(FILE *file);
82 
87 struct link *link_attach_to_fd(int fd);
88 
89 
96 struct link *link_serve(int port);
97 
104 struct link *link_serve_range(int low, int high);
105 
112 struct link *link_serve_address(const char *addr, int port);
113 
121 struct link *link_serve_addrrange(const char *addr, int low, int high);
122 
128 struct link *link_accept(struct link *parent, time_t stoptime);
129 
130 
137 int link_ssl_wrap_server(struct link *l, const char *key, const char *cert);
138 
139 
149 ssize_t link_read(struct link *link, char *data, size_t length, time_t stoptime);
150 
160 ssize_t link_read_avail(struct link *link, char *data, size_t length, time_t stoptime);
161 
169 ssize_t link_write(struct link *link, const char *data, size_t length, time_t stoptime);
170 
171 /* Write a string of length len to a connection. All data is written until
172  * finished or an error is encountered.
173 @param link The link to write.
174 @param str A pointer to the string.
175 @param len Length of the string.
176 @param stoptime The time at which to abort.
177 @return The number of bytes actually written, or less than zero on error.
178 */
179 ssize_t link_putlstring(struct link *link, const char *str, size_t len, time_t stoptime);
180 
181 /* Write a C string to a connection. All data is written until finished or an
182  error is encountered. It is defined as a macro.
183 @param link The link to write.
184 @param str A pointer to the string.
185 @param stoptime The time at which to abort.
186 @return The number of bytes actually written, or less than zero on error.
187 */
188 #define link_putstring(l,s,t) (link_putlstring(l,s,strlen(s),t))
189 
190 /* Write a C literal string to a connection. All data is written until finished
191  or an error is encountered. It is defined as a macro.
192 @param link The link to write.
193 @param str A pointer to the string.
194 @param stoptime The time at which to abort.
195 @return The number of bytes actually written, or less than zero on error.
196 */
197 #define link_putliteral(l,s,t) (link_putlstring(l,s "",((sizeof(s))-1),t))
198 
207 ssize_t link_putfstring(struct link *link, const char *fmt, time_t stoptime, ...)
208  __attribute__ (( format(printf,2,4) )) ;
209 
218 ssize_t link_putvfstring(struct link *link, const char *fmt, time_t stoptime, va_list va);
219 
227 int link_usleep(struct link *link, int usec, int reading, int writing);
228 
229 int link_usleep_mask(struct link *link, int usec, sigset_t *mask, int reading, int writing);
230 
238 int link_sleep(struct link *link, time_t stoptime, int reading, int writing);
239 
243 void link_close(struct link *link);
244 
245 
250 void link_detach(struct link *link);
251 
263 void link_window_set(int send_window, int recv_window);
264 
271 void link_window_get(struct link *link, int *send_window, int *recv_window);
272 
284 int link_readline(struct link *link, char *line, size_t length, time_t stoptime);
285 
290 int link_fd(struct link *link);
291 
292 
297 int link_using_ssl(struct link *link);
298 
299 int link_keepalive(struct link *link, int onoff);
300 
301 int link_nonblocking(struct link *link, int onoff);
302 
303 
308 int link_buffer_empty(struct link *link);
309 
316 int link_address_local(struct link *link, char *addr, int *port);
317 
324 int link_address_remote(struct link *link, char *addr, int *port);
325 
326 ssize_t link_stream_to_buffer(struct link *link, char **buffer, time_t stoptime);
327 
328 int64_t link_stream_to_fd(struct link *link, int fd, int64_t length, time_t stoptime);
329 int64_t link_stream_to_file(struct link *link, FILE * file, int64_t length, time_t stoptime);
330 
331 int64_t link_stream_from_fd(struct link *link, int fd, int64_t length, time_t stoptime);
332 int64_t link_stream_from_file(struct link *link, FILE * file, int64_t length, time_t stoptime);
333 
334 int64_t link_soak(struct link *link, int64_t length, time_t stoptime);
335 
337 typedef enum {
340 } link_tune_t;
341 
348 int link_tune(struct link *link, link_tune_t mode);
349 
351 #define LINK_READ 1
352 
354 #define LINK_WRITE 2
355 
357 struct link_info {
358  struct link *link;
359  int events;
360  int revents;
361 };
362 
371 int link_poll(struct link_info *array, int nlinks, int msec);
372 
373 int errno_is_temporary(int e);
374 
375 #endif
Definition: buffer.h:26