xref: /dflybsd-src/usr.sbin/ppp/throughput.h (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino /*-
286d7f5d3SJohn Marino  * Copyright (c) 1997 Brian Somers <brian@Awfulhak.org>
386d7f5d3SJohn Marino  * All rights reserved.
486d7f5d3SJohn Marino  *
586d7f5d3SJohn Marino  * Redistribution and use in source and binary forms, with or without
686d7f5d3SJohn Marino  * modification, are permitted provided that the following conditions
786d7f5d3SJohn Marino  * are met:
886d7f5d3SJohn Marino  * 1. Redistributions of source code must retain the above copyright
986d7f5d3SJohn Marino  *    notice, this list of conditions and the following disclaimer.
1086d7f5d3SJohn Marino  * 2. Redistributions in binary form must reproduce the above copyright
1186d7f5d3SJohn Marino  *    notice, this list of conditions and the following disclaimer in the
1286d7f5d3SJohn Marino  *    documentation and/or other materials provided with the distribution.
1386d7f5d3SJohn Marino  *
1486d7f5d3SJohn Marino  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1586d7f5d3SJohn Marino  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1686d7f5d3SJohn Marino  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1786d7f5d3SJohn Marino  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1886d7f5d3SJohn Marino  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1986d7f5d3SJohn Marino  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2086d7f5d3SJohn Marino  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2186d7f5d3SJohn Marino  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2286d7f5d3SJohn Marino  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2386d7f5d3SJohn Marino  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2486d7f5d3SJohn Marino  * SUCH DAMAGE.
2586d7f5d3SJohn Marino  *
2686d7f5d3SJohn Marino  * $FreeBSD: src/usr.sbin/ppp/throughput.h,v 1.8.2.2 2000/09/16 23:09:06 brian Exp $
2786d7f5d3SJohn Marino  * $DragonFly: src/usr.sbin/ppp/throughput.h,v 1.2 2003/06/17 04:30:01 dillon Exp $
2886d7f5d3SJohn Marino  */
2986d7f5d3SJohn Marino 
3086d7f5d3SJohn Marino #define SAMPLE_PERIOD 5		/* Default sample period */
3186d7f5d3SJohn Marino 
3286d7f5d3SJohn Marino #define THROUGHPUT_OVERALL 0x0001
3386d7f5d3SJohn Marino #define THROUGHPUT_CURRENT 0x0002
3486d7f5d3SJohn Marino #define THROUGHPUT_PEAK    0x0004
3586d7f5d3SJohn Marino #define THROUGHPUT_ALL     0x0007
3686d7f5d3SJohn Marino 
3786d7f5d3SJohn Marino struct pppThroughput {
3886d7f5d3SJohn Marino   time_t uptime, downtime;
3986d7f5d3SJohn Marino   unsigned long long OctetsIn;
4086d7f5d3SJohn Marino   unsigned long long OctetsOut;
4186d7f5d3SJohn Marino   unsigned long long PacketsIn;
4286d7f5d3SJohn Marino   unsigned long long PacketsOut;
4386d7f5d3SJohn Marino   int SamplePeriod;
4486d7f5d3SJohn Marino   struct {
4586d7f5d3SJohn Marino     unsigned long long *SampleOctets;
4686d7f5d3SJohn Marino     unsigned long long OctetsPerSecond;
4786d7f5d3SJohn Marino   } in, out;
4886d7f5d3SJohn Marino   unsigned long long BestOctetsPerSecond;
4986d7f5d3SJohn Marino   time_t BestOctetsPerSecondTime;
5086d7f5d3SJohn Marino   int nSample;
5186d7f5d3SJohn Marino   unsigned rolling : 1;
5286d7f5d3SJohn Marino   struct pppTimer Timer;
5386d7f5d3SJohn Marino   struct {
5486d7f5d3SJohn Marino     void *data;
5586d7f5d3SJohn Marino     void (*fn)(void *v);
5686d7f5d3SJohn Marino   } callback;
5786d7f5d3SJohn Marino };
5886d7f5d3SJohn Marino 
5986d7f5d3SJohn Marino extern void throughput_init(struct pppThroughput *, int);
6086d7f5d3SJohn Marino extern void throughput_destroy(struct pppThroughput *);
6186d7f5d3SJohn Marino extern void throughput_disp(struct pppThroughput *, struct prompt *);
6286d7f5d3SJohn Marino extern void throughput_log(struct pppThroughput *, int, const char *);
6386d7f5d3SJohn Marino extern void throughput_start(struct pppThroughput *, const char *, int);
6486d7f5d3SJohn Marino extern void throughput_restart(struct pppThroughput *, const char *, int);
6586d7f5d3SJohn Marino extern void throughput_stop(struct pppThroughput *);
6686d7f5d3SJohn Marino extern void throughput_addin(struct pppThroughput *, long long);
6786d7f5d3SJohn Marino extern void throughput_addout(struct pppThroughput *, long long);
6886d7f5d3SJohn Marino extern void throughput_clear(struct pppThroughput *, int, struct prompt *);
6986d7f5d3SJohn Marino extern void throughput_callback(struct pppThroughput *, void (*)(void *),
7086d7f5d3SJohn Marino                                 void *);
7186d7f5d3SJohn Marino extern int throughput_uptime(struct pppThroughput *);
72