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