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 * $Id: datalink.h,v 1.4 1998/06/15 19:05:19 brian Exp $ 27 */ 28 29 #define DATALINK_CLOSED (0) 30 #define DATALINK_OPENING (1) 31 #define DATALINK_HANGUP (2) 32 #define DATALINK_DIAL (3) 33 #define DATALINK_LOGIN (4) 34 #define DATALINK_READY (5) 35 #define DATALINK_LCP (6) 36 #define DATALINK_AUTH (7) 37 #define DATALINK_CBCP (8) 38 #define DATALINK_OPEN (9) 39 40 #define DATALINK_MAXNAME (20) /* Maximum datalink::name length */ 41 42 /* How to close the link */ 43 #define CLOSE_NORMAL 0 44 #define CLOSE_STAYDOWN 1 45 #define CLOSE_LCP 2 46 47 struct iovec; 48 struct prompt; 49 struct physical; 50 struct bundle; 51 52 struct datalink { 53 struct descriptor desc; /* We play either a physical or a chat */ 54 int state; /* Our DATALINK_* state */ 55 struct physical *physical; /* Our link */ 56 57 struct chat chat; /* For bringing the link up & down */ 58 59 unsigned stayonline : 1; /* stay online when LCP is closed ? */ 60 struct { 61 unsigned run : 1; /* run scripts ? */ 62 unsigned packetmode : 1; /* Go into packet mode after login ? */ 63 } script; 64 65 struct pppTimer dial_timer; /* For timing between close & open */ 66 67 struct { 68 struct { 69 char dial[SCRIPT_LEN]; /* dial */ 70 char login[SCRIPT_LEN]; /* login */ 71 char hangup[SCRIPT_LEN]; /* hangup */ 72 } script; 73 struct { 74 char list[SCRIPT_LEN]; /* Telephone Numbers */ 75 } phone; 76 struct { 77 int max; /* initially try again this number of times */ 78 int next_timeout; /* Redial next timeout value */ 79 int timeout; /* Redial timeout value (end of phone list) */ 80 } dial; 81 struct { 82 int max; /* initially try again this number of times */ 83 int timeout; /* Timeout before reconnect on carrier loss */ 84 } reconnect; 85 struct callback callback; /* Direction depends on physical type */ 86 struct cbcpcfg cbcp; /* Direction depends on phys type & callback */ 87 } cfg; /* All our config data is in here */ 88 89 struct { 90 char list[SCRIPT_LEN]; /* copy of cfg.list for strsep() */ 91 char *next; /* Next phone from the list */ 92 char *alt; /* Next phone from the list */ 93 const char *chosen; /* Chosen phone number after DIAL */ 94 } phone; 95 96 struct cbcp cbcp; 97 98 int dial_tries; /* currently try again this number of times */ 99 unsigned reconnect_tries; /* currently try again this number of times */ 100 101 char *name; /* Our name */ 102 103 struct peerid peer; /* Peer identification */ 104 105 struct fsm_parent fsmp; /* Our callback functions */ 106 const struct fsm_parent *parent; /* Our parent */ 107 108 struct authinfo pap; /* Authentication using pap */ 109 struct chap chap; /* Authentication using chap */ 110 111 struct mp_link mp; /* multilink data */ 112 113 struct bundle *bundle; /* for the moment */ 114 struct datalink *next; /* Next in the list */ 115 }; 116 117 #define descriptor2datalink(d) \ 118 ((d)->type == DATALINK_DESCRIPTOR ? (struct datalink *)(d) : NULL) 119 120 extern struct datalink *datalink_Create(const char *name, struct bundle *, int); 121 extern struct datalink *datalink_Clone(struct datalink *, const char *); 122 extern struct datalink *iov2datalink(struct bundle *, struct iovec *, int *, 123 int, int); 124 extern int datalink2iov(struct datalink *, struct iovec *, int *, int, pid_t); 125 extern struct datalink *datalink_Destroy(struct datalink *); 126 extern void datalink_GotAuthname(struct datalink *, const char *, int); 127 extern void datalink_Up(struct datalink *, int, int); 128 extern void datalink_Close(struct datalink *, int); 129 extern void datalink_Down(struct datalink *, int); 130 extern void datalink_StayDown(struct datalink *); 131 extern void datalink_DontHangup(struct datalink *); 132 extern void datalink_AuthOk(struct datalink *); 133 extern void datalink_AuthNotOk(struct datalink *); 134 extern void datalink_NCPUp(struct datalink *); 135 extern void datalink_CBCPComplete(struct datalink *); 136 extern void datalink_CBCPFailed(struct datalink *); 137 extern int datalink_Show(struct cmdargs const *); 138 extern int datalink_SetRedial(struct cmdargs const *); 139 extern int datalink_SetReconnect(struct cmdargs const *); 140 extern const char *datalink_State(struct datalink *); 141 extern void datalink_Rename(struct datalink *, const char *); 142 extern char *datalink_NextName(struct datalink *); 143 extern int datalink_RemoveFromSet(struct datalink *, fd_set *, fd_set *, 144 fd_set *); 145 extern int datalink_SetMode(struct datalink *, int); 146