xref: /dragonfly/usr.sbin/ppp/chat.h (revision 0ca59c34)
1 /*-
2  * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/usr.sbin/ppp/chat.h,v 1.15.2.1 2000/03/21 10:23:03 brian Exp $
27  * $DragonFly: src/usr.sbin/ppp/chat.h,v 1.2 2003/06/17 04:30:00 dillon Exp $
28  */
29 
30 #define CHAT_EXPECT 0
31 #define CHAT_SEND   1
32 #define CHAT_DONE   2
33 #define CHAT_FAILED 3
34 
35 #define MAXABORTS   50
36 
37 struct physical;
38 
39 struct chat {
40   struct fdescriptor desc;
41   struct physical *physical;
42 
43   int state;				/* Our CHAT_* status */
44 
45   char script[LINE_LEN];		/* Our arg buffer */
46   char *argv[MAXARGS];			/* Our arguments (pointing to script) */
47   int argc;				/* Number of argv's */
48 
49   int arg;				/* Our current arg number */
50   char exp[LINE_LEN];			/* Our translated current argument */
51   char *argptr;				/* Our current arg pointer */
52   int arglen;				/* The length of argptr */
53   char *nargptr;			/* Our next for expect-send-expect */
54 
55   char buf[LINE_LEN*2];			/* Our input */
56   char *bufstart;			/* start of relevent data */
57   char *bufend;				/* end of relevent data */
58 
59   int TimeoutSec;			/* Expect timeout value */
60   int TimedOut;				/* We timed out */
61 
62   const char *phone;			/* Our phone number */
63 
64   struct {
65     struct {
66       char *data;			/* Abort the dial if we get one */
67       int len;
68     } string[MAXABORTS];
69     int num;				/* How many AbortStrings */
70   } abort;
71 
72   struct pppTimer pause;		/* Inactivity timer */
73   struct pppTimer timeout;		/* TimeoutSec timer */
74 };
75 
76 #define descriptor2chat(d) \
77   ((d)->type == CHAT_DESCRIPTOR ? (struct chat *)(d) : NULL)
78 #define	VECSIZE(v)	(sizeof(v) / sizeof(v[0]))
79 
80 extern void chat_Init(struct chat *, struct physical *);
81 extern int chat_Setup(struct chat *, const char *, const char *);
82 extern void chat_Finish(struct chat *);
83 extern void chat_Destroy(struct chat *);
84