xisb.h revision 35c4bbdf
1/*
2 * Copyright (c) 1997  Metro Link Incorporated
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17 * THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 *
22 * Except as contained in this notice, the name of the Metro Link shall not be
23 * used in advertising or otherwise to promote the sale, use or other dealings
24 * in this Software without prior written authorization from Metro Link.
25 *
26 */
27
28#ifndef	_xisb_H_
29#define _xisb_H_
30
31#include <unistd.h>
32
33/******************************************************************************
34 *		Definitions
35 *									structs, typedefs, #defines, enums
36 *****************************************************************************/
37
38typedef struct _XISBuffer {
39    int fd;
40    int trace;
41    int block_duration;
42    ssize_t current;            /* bytes read */
43    ssize_t end;
44    ssize_t buffer_size;
45    unsigned char *buf;
46} XISBuffer;
47
48/******************************************************************************
49 *		Declarations
50 *								variables:	use xisb_LOC in front
51 *											of globals.
52 *											put locals in the .c file.
53 *****************************************************************************/
54extern _X_EXPORT XISBuffer *XisbNew(int fd, ssize_t size);
55extern _X_EXPORT void XisbFree(XISBuffer * b);
56extern _X_EXPORT int XisbRead(XISBuffer * b);
57extern _X_EXPORT ssize_t XisbWrite(XISBuffer * b, unsigned char *msg,
58                                   ssize_t len);
59extern _X_EXPORT void XisbTrace(XISBuffer * b, int trace);
60extern _X_EXPORT void XisbBlockDuration(XISBuffer * b, int block_duration);
61
62/*
63 *	DO NOT PUT ANYTHING AFTER THIS ENDIF
64 */
65#endif
66