bbsmod.h

Entry points for BBS modules.

This header defines the main entry (and exit) points for Megistos modules. It handles initialising different subsets of the API depending on the type of module.

Please be aware that this part of the library is undergoing an almost complete redesign.

Original banner, legalese and change history follow

 *****************************************************************************
 **                                                                         **
 **  FILE:     bbsmod.h                                                     **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, June 94                                                   **
 **  PURPOSE:  Interface to module functions bbsmod.c                       **
 **  NOTES:                                                                 **
 **  LEGALESE:                                                              **
 **                                                                         **
 **  This program is free software; you  can redistribute it and/or modify  **
 **  it under the terms of the GNU  General Public License as published by  **
 **  the Free Software Foundation; either version 2 of the License, or (at  **
 **  your option) any later version.                                        **
 **                                                                         **
 **  This program is distributed  in the hope  that it will be useful, but  **
 **  WITHOUT    ANY WARRANTY;   without  even  the    implied warranty  of  **
 **  MERCHANTABILITY or  FITNESS FOR  A PARTICULAR  PURPOSE.   See the GNU  **
 **  General Public License for more details.                               **
 **                                                                         **
 **  You  should have received a copy   of the GNU  General Public License  **
 **  along with    this program;  if   not, write  to  the   Free Software  **
 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              **
 **                                                                         **
 *****************************************************************************


 *
 * $Id: bbsmod.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: bbsmod.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 0.4  1998/12/27 15:19:19  alexios
 * Declare the BBS user's UID and GID.
 *
 * Revision 0.3  1998/07/26 21:17:06  alexios
 * Added structure to declare modules and their individual
 * functions, plus functions to initialise said structure.
 * The setprogname() function is necessary for proper error
 * reporting.
 *
 * Revision 0.2  1997/11/06 20:03:39  alexios
 * Added GPL legalese to the top of this file.
 *
 * Revision 0.1  1997/08/26 15:48:53  alexios
 * First registered revision. Adequate.
 *
 *
 *

mod_handler

Module handler.

mod_handler_t

Module handler.

mod_info_t

Module information block.

bbs_uid

The UNIX user ID of the `bbs' user

bbs_gid

The UNIX group ID of the `bbs' user

*sysvar

A block of system-wide variables

Initialisation mode flags

Subsystems of the BBS API to be initialised.

mod_setinfo

Set module information block.

mod_setprogname

Set program name.

mod_main

Module entry point.

mod_init

Initialise a module.

mod_done

Prepares a module for exit.

mod_end

Prepares a module for exit.

mod_regpid

Register this process as an interactive one.

mod_isbot

Document me.

mod_setbot

Document me.

Author:

Alexios

Alphabetic index