src/vfer_api.h

Go to the documentation of this file.

/*
 * Copyright 2005, 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */
/**
 *
 * @file   vfer_api.h
 * @author Ivan Beschastnikh
 * @brief  Defines all api functions used by applications.
 *
 * This is the file that is to be included by applications that would
 * like to use VFer.
 *
 * -    11/10/05        ivan            added reliability function supporting types
 * -    10/17/05        ivan            added vfer_debug function prototype
 * -    06/29/05        ivan            migration to the api specified in I2's writeup (version 6)
 * -    05/18/05        ivan            renamed to api.h
 * -    05/18/05        ivan            created
 */

#ifndef VFER_API_H
#define VFER_API_H

/*
 * includes
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <string.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <pthread.h>    /* thread support => compile with -lpthread */
#include <signal.h>
#include <sys/select.h> /* select call */
#include <stdbool.h>

#include "vfer.h"
#include "vfer_packet.h"
#include "vfer_control.h"

/* PMTU: Determine best way to set DF bit in IP header */
#ifdef IP_DONTFRAG
        #define SET_DF_BIT(SOCKFD, RET){\
                RET = setsockopt(SOCKFD, IPPROTO_IP, IP_DONTFRAG, NULL, 0);}
#else
        #ifdef IP_PMTUDISC_DO
                #define SET_DF_BIT(SOCKFD, RET){\
                        int dfval = IP_PMTUDISC_DO;\
                        RET = setsockopt(SOCKFD, SOL_IP, IP_MTU_DISCOVER, &dfval, sizeof(int));}
        #else
                #define SET_DF_BIT(SOCKFD, RET){ RET = -1; }
        #endif
#endif

/*
 * types
 */

/* see in globals.h */


//! generic transmit function argument
typedef void* vfer_trnsm_arg;

//! generic transmit function type
/** vfer__recvfile() and vfer__sendfile can both use arbitrary
 * function to send and retrieve packets. Because different transmit
 * functions work with different sockets, the transmit functions
 * are casted to this generic type before they are passed to
 * vfer__recvfile() and vfer__sendfile().
 *
 * Currently this technique is used to prevent code duplication between
 * vls_sendfile() and vfer_sendfile() and vls_recvfile() and vfer_recvfile().
 **/
typedef int (*vfer_trnsm_fn)(vfer_trnsm_arg sock, void* buf, size_t len);


/*
 * function prototypes
 */

/* connection setup/teardown functions */
vfer_fd         vfer_socket     (int socktype);
int             vfer_close      (vfer_fd vfd);
int             vfer_connect    (vfer_fd vfd, const struct sockaddr *serv_addr, int addrlen);
int             vfer_bind       (vfer_fd vfd, struct sockaddr *addr, int len);
int             vfer_listen     (vfer_fd vfd, int backlog);
vfer_fd         vfer_accept     (vfer_fd vfd, struct sockaddr *addr, socklen_t *len);


/* option handling functions */
int             vfer_setsockopt (vfer_fd vfd, int optname, void *optval, int optlen);
int             vfer_getsockopt (vfer_fd vfd, int optname, void *optval, int *optlen);

/* data transfer functions */
int             vfer_send       (vfer_fd vfd, const void * buf, size_t len);
int             vfer_recv       (vfer_fd vfd, void *buf, size_t len);
int             vfer__sendfile  (vfer_trnsm_fn fn, vfer_trnsm_arg arg, int frame_size,
                                 int fd, off_t offset, size_t size);
int             vfer__recvfile  (vfer_trnsm_fn fn, vfer_trnsm_arg arg, uint32_t frame_size,
                                 int fd, off_t offset, size_t size);
int             vfer_sendfile   (vfer_fd vfd, int fd, off_t offset, size_t size);
int             vfer_recvfile   (vfer_fd vfd, int fd, off_t offset, size_t size);

/* asynchronous IO functions */
int             vfer_selectmark (vfer_fd vfd, int mark);
int             vfer_selecttest (vfer_fd vfd);
int             vfer_select     (int len, vfer_fd *vfds, struct timeval *timeout);

/* information reporting functions */
vfer_stats      vfer_sockstats  (vfer_fd vfd);
int             vfer_debug      (FILE* debug_file, FILE* error_file, const char* layers);
int             vfer_sockerror  (vfer_fd vfd);
char*           vfer_errortext  (int err);
int             vfer_getsockname(vfer_fd vfd, struct sockaddr *name, socklen_t* len);
bool            vfer_is_stream (vfer_fd fd);
ssize_t         vfer_max_frame_size (vfer_fd fd);


#endif /* VFER_API_H */

---