link.h

Go to the documentation of this file.

/*
Copyright (C) 2003-2004 Douglas Thain and the University of Wisconsin
Copyright (C) 2005- The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/

#ifndef LINK_H
#define LINK_H

#include <sys/types.h>

#include <limits.h>
#include <signal.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <time.h>

#define LINK_ADDRESS_MAX 48

#define LINK_PORT_ANY 0

#define LINK_FOREVER ((time_t)INT_MAX)
#define LINK_NOWAIT ((time_t)INT_MIN)

struct link *link_connect(const char *addr, int port, time_t stoptime);

int link_ssl_wrap_connect(struct link *link);

struct link *link_attach_to_file(FILE *file);

struct link *link_attach_to_fd(int fd);


struct link *link_serve(int port);

struct link *link_serve_range(int low, int high);

struct link *link_serve_address(const char *addr, int port);

struct link *link_serve_addrrange(const char *addr, int low, int high);

struct link *link_accept(struct link *parent, time_t stoptime);


int link_ssl_wrap_accept(struct link *l, const char *key, const char *cert);


ssize_t link_read(struct link *link, char *data, size_t length, time_t stoptime);

ssize_t link_read_avail(struct link *link, char *data, size_t length, time_t stoptime);

ssize_t link_write(struct link *link, const char *data, size_t length, time_t stoptime);

/* Write a string of length len to a connection. All data is written until
 * finished or an error is encountered.
@param link The link to write.
@param str A pointer to the string.
@param len Length of the string.
@param stoptime The time at which to abort.
@return The number of bytes actually written, or less than zero on error.
*/
ssize_t link_putlstring(struct link *link, const char *str, size_t len, time_t stoptime);

/* Write a C string to a connection. All data is written until finished or an
   error is encountered. It is defined as a macro.
@param link The link to write.
@param str A pointer to the string.
@param stoptime The time at which to abort.
@return The number of bytes actually written, or less than zero on error.
*/
#define link_putstring(l,s,t)  (link_putlstring(l,s,strlen(s),t))

/* Write a C literal string to a connection. All data is written until finished
   or an error is encountered. It is defined as a macro.
@param link The link to write.
@param str A pointer to the string.
@param stoptime The time at which to abort.
@return The number of bytes actually written, or less than zero on error.
*/
#define link_putliteral(l,s,t)  (link_putlstring(l,s "",((sizeof(s))-1),t))

ssize_t link_putfstring(struct link *link, const char *fmt, time_t stoptime, ...)
  __attribute__ (( format(printf,2,4) )) ;

ssize_t link_putvfstring(struct link *link, const char *fmt, time_t stoptime, va_list va);

int link_usleep(struct link *link, int usec, int reading, int writing);

int link_usleep_mask(struct link *link, int usec, sigset_t *mask, int reading, int writing);

int link_sleep(struct link *link, time_t stoptime, int reading, int writing);

void link_close(struct link *link);


void link_detach(struct link *link);

void link_window_set(int send_window, int recv_window);

void link_window_get(struct link *link, int *send_window, int *recv_window);

int link_readline(struct link *link, char *line, size_t length, time_t stoptime);

int link_fd(struct link *link);


int link_using_ssl(struct link *link);

int link_keepalive(struct link *link, int onoff);

int link_nonblocking(struct link *link, int onoff);


int link_buffer_empty(struct link *link);

int link_address_local(struct link *link, char *addr, int *port);

int link_address_remote(struct link *link, char *addr, int *port);

ssize_t link_stream_to_buffer(struct link *link, char **buffer, time_t stoptime);

int64_t link_stream_to_fd(struct link *link, int fd, int64_t length, time_t stoptime);
int64_t link_stream_to_file(struct link *link, FILE * file, int64_t length, time_t stoptime);

int64_t link_stream_from_fd(struct link *link, int fd, int64_t length, time_t stoptime);
int64_t link_stream_from_file(struct link *link, FILE * file, int64_t length, time_t stoptime);

int64_t link_soak(struct link *link, int64_t length, time_t stoptime);

typedef enum {
        LINK_TUNE_INTERACTIVE,  
        LINK_TUNE_BULK          
} link_tune_t;

int link_tune(struct link *link, link_tune_t mode);

#define LINK_READ 1

#define LINK_WRITE 2

struct link_info {
        struct link *link;  
        int events;         
        int revents;        
};

int link_poll(struct link_info *array, int nlinks, int msec);

int errno_is_temporary(int e);

#endif