luasocket/src/io.h

#ifndef IO_H
#define IO_H
/*=========================================================================*\
* Input/Output abstraction
* LuaSocket toolkit
*
* This module defines the interface that LuaSocket expects from the
* transport layer for streamed input/output. The idea is that if any
* transport implements this interface, then the buffer.c functions
* automatically work on it.
*
* The module socket.h implements this interface, and thus the module tcp.h
* is very simple.
*
* RCS ID: $Id$
\*=========================================================================*/
#include <stdio.h>
#include <lua.h>

#include "timeout.h"

/* IO error codes */
enum {
    IO_DONE,            /* operation completed successfully */
    IO_TIMEOUT,         /* operation timed out */
    IO_CLOSED,          /* the connection has been closed */
    IO_CLIPPED,         /* maxium bytes count reached */
    IO_USER             /* last element in enum is user custom error */
};

/* interface to send function */
typedef int (*p_send) (
    void *ctx,          /* context needed by send */ 
    const char *data,   /* pointer to buffer with data to send */
    size_t count,       /* number of bytes to send from buffer */
    size_t *sent,       /* number of bytes sent uppon return */
    p_tm tm             /* timeout control */
);

/* returns an error string */
typedef const char *(*p_geterr) (
    void *ctx,          /* context needed by geterror */ 
    int code            /* error code */
);
 
/* interface to recv function */
typedef int (*p_recv) (
    void *ctx,          /* context needed by recv */ 
    char *data,         /* pointer to buffer where data will be writen */
    size_t count,       /* number of bytes to receive into buffer */
    size_t *got,        /* number of bytes received uppon return */
    p_tm tm             /* timeout control */
);

/* IO driver definition */
typedef struct t_io_ {
    void *ctx;          /* context needed by send/recv */
    p_send send;        /* send function pointer */
    p_recv recv;        /* receive function pointer */
    p_geterr geterr;    /* receive function pointer */
} t_io;
typedef t_io *p_io;

const char *io_strerror(int code);
void io_pusherror(lua_State *L, p_io io, int code);
void io_init(p_io io, p_send send, p_recv recv, p_geterr geterr, void *ctx);

#endif /* IO_H */