channels.h

BBS Channel status manipulations (aka lines, TTYs)

This file provides an API for controlling BBS channels. Each channel has a number of status components:

• Channel mode (e.g. Normal, No-Answer, Busy, etc).

• Result code (e.g. OK, RING, ERROR, etc).

• Line speed (e.g. 33600 bps),

• Occupant of line (a user ID, usually).

The functionality declared here helps deal with these aspects of channels. This is usually not for modules' use. Unless of course you have some strange module that touches channels.

Original banner, legalese and change history follow.

 *****************************************************************************
 **                                                                         **
 **  FILE:     channels.h                                                   **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, December 98                                               **
 **  PURPOSE:  Interface to channels.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: channels.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: channels.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 1.1  1999/07/18 21:13:24  alexios
 * Cosmetic changes. Added MetaBBS support.
 *
 * Revision 1.0  1998/12/27 15:19:02  alexios
 * Initial revision
 *
 *
 *

Channel modes

Basic line states.

Channel result codes.

Result codes.

channel_states

String versions of the LST_x flags.

channel_results

String versions of the LSR_x flags.

channel_status

Channel status structure.

channel_getstatus

Get channel status.

channel_setstatus

Set channel status.

channel_setmode

Set channel mode.

channel_setresult

Set channel result code.

channel_hangup

Hangup this user's channel.

channel_disconnect

Disconnect a channel.

channel_baudstg

Formats channel speed as a string.

Author:

Alexios

Alphabetic index