src/vfer_accept_queue.h

Go to the documentation of this file.

/*
 * Copyright 2005, 2006, Internet2
 * Legal conditions are in file LICENSE
 * (MD5 = c434f2e53b8089d8b4d0172c7ce07360).
 */
/**
 *
 * @file   vfer_accept_queue.h
 * @author Ivan Beschastnikh
 * @brief  Header file for accept_queue.c
 *
 * Defines the necessary data structures and prototypes.
 *
 * -      05/26/05        ivan            created
 */


#ifndef VFER_ACCEPT_QUEUE_H
#define VFER_ACCEPT_QUEUE_H

/*
 * includes
 */

#include <stdio.h>      /* printf & NULL def */
#include <pthread.h>    /* mutex ops */
#include "vfer_packet.h"
                           
/*
 * data structures
 */

/**
 * @brief A queued connection link in the accept_queue doubly linked list
 *
 * Caches the original request packet received and has links to the
 * next and previous queued connection in the doubly linked list
 * (links in the accept_queue type).
 *
 */
typedef struct queued_conn {
        /** file descriptor for socket */
        int fd;
        /** remote address */
        struct sockaddr sa;
        /** request packet pointer */
        struct packet* request;
        /** next member in the list */
        struct queued_conn* next;
        /** previous member in the list */
        struct queued_conn* prev;
} queued_conn;

/**
 * @brief A doubly linked list of backlogged connections waiting to be
 * accepted.
 */
typedef struct accept_queue {
        /** max number of queued connections allowed in the list */
        int backlog;
        /** number of total queued connections in the list */
        int count;
        /** list of queued connections (first in the queue)*/
        struct queued_conn* first;
        /** last in the list of queued connections (last in the queue)*/
        struct queued_conn* last;
} accept_queue;

/*
 * function prototypes
 */

accept_queue*   Accept_Queue_Create     (int backlog);
void            Accept_Queue_Delete     (accept_queue* ac);
int             Accept_Queue_Enqueue    (accept_queue* ac, int fd, struct sockaddr sa, struct packet* request);
queued_conn*    Accept_Queue_Dequeue    (accept_queue* ac);

#endif  /* VFER_ACCEPT_QUEUE_H */

---