eyBuildLib API Reference : eyBuildLib

ebcblock

NAME

ebcblock - eybuild task control block

ROUTINES

ebInit( ) - init current task control block
getEbCBlock( ) - get eybuild control block
ebRespondFlush( ) - flash current task respond
ebRequestReset( ) - reset current task control block for FAST_CGI
ebClean( ) - clean current task control block
ebGetStat( ) - get stat information

DESCRIPTION

eybuild task control block

/* user hooks */
typedef BOOL (*PRE_DISPATCH)(EB_BLOCK * pblk, char * pname, int type);
typedef BOOL (*POST_DISPATCH)(EB_BLOCK * pblk, char * pname, int type);
typedef BOOL (*ERR_DISPATCH)(int errnum, char * errmsg);

/* typedefs */
typedef struct EB_STAT
{
    int             options;            /* page map options */
    int             cookie_maxlen;      /* max cookie buffer length */
    int             max_cookies;        /* max cookies number */
    int             query_maxlen;       /* max query buffer length */
    int             max_querys;         /* max querys number */
    int             mainpage_maxlen;    /* max size of mainpage buffer */
    int             tmpbuf_maxlen;      /* for something tmp returned and then output,
                                         * eg: ebUrlDecode, ebUrlEncode
                                         */
    BOOL            disable_log;        /* disabe log, default log enabled */
    PRE_DISPATCH    pre_dispatch_hook;  /* previous dispatch hook */
    POST_DISPATCH   post_dispatch_hook; /* post dispatch hook */
    ERR_DISPATCH    error_hook;         /* send error messg */
} EB_STAT;

INCLUDE

ebcblock.h

SEE ALSO

ebquery.h, ebhandle.h

---

eyBuildLib : Routines

ebInit( )

NAME

ebInit( ) - init current task control block

SYNOPSIS

int ebInit
    (
    EB_STAT * pstat
    )

DESCRIPTION

this routine is to initilized current task control block

RETURN

OK/ERROR

SEE ALSO

ebcblock

---

eyBuildLib : Routines

getEbCBlock( )

NAME

getEbCBlock( ) - get eybuild control block

SYNOPSIS

EB_BLOCK * getEbCBlock ()

DESCRIPTION

this routine the control block of current task(for VxWorks) or process(other OS). If control block have not initilized, this routine will try to init it with default setting.

RETURN

pointer to current control block, or NULL if initilized ERROR

SEE ALSO

ebcblock

---

eyBuildLib : Routines

ebRespondFlush( )

NAME

ebRespondFlush( ) - flash current task respond

SYNOPSIS

int ebRespondFlush (void)

DESCRIPTION

this routine is to flash current task respond

RETURN

OK/ERROR

SEE ALSO

ebcblock

---

eyBuildLib : Routines

ebRequestReset( )

NAME

ebRequestReset( ) - reset current task control block for FAST_CGI

SYNOPSIS

int ebRequestReset ()

DESCRIPTION

this routine is to reset current task control block and refresh current request list.

RETURN

OK/ERROR

SEE ALSO

ebcblock

---

eyBuildLib : Routines

ebClean( )

NAME

ebClean( ) - clean current task control block

SYNOPSIS

int ebClean ()

DESCRIPTION

this routine is to clean current task control block, while exit CGI. Usually, user need call ebClean( ) manually.

RETURN

OK/ERROR

SEE ALSO

ebcblock

---

eyBuildLib : Routines

ebGetStat( )

NAME

ebGetStat( ) - get stat information

SYNOPSIS

int ebGetStat
    (
    EB_STAT * pstat
    )

DESCRIPTION

this routine is to get stat information

RETURNS

OK/ERROR

SEE ALSO

ebcblock