diff options
Diffstat (limited to 'share/man/man4/ng_car.4')
| -rw-r--r-- | share/man/man4/ng_car.4 | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/share/man/man4/ng_car.4 b/share/man/man4/ng_car.4 index 79967e72dd5e..348b03d64d64 100644 --- a/share/man/man4/ng_car.4 +++ b/share/man/man4/ng_car.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 11, 2007 +.Dd November 13, 2012 .Dt NG_CAR 4 .Os .Sh NAME @@ -50,7 +50,7 @@ Traffic shaping with RED. .El .Sh HOOKS This node type supports the following hooks: -.Bl -tag -width indent +.Bl -tag -width ".Va upper" .It Va upper Hook leading to upper layer protocols. .It Va lower @@ -73,7 +73,7 @@ is considered traffic. .Sh MODES OF OPERATION Each hook can operate in one of the following modes: -.Bl -tag -width indent +.Bl -tag -width foo .It Dv NG_CAR_SINGLE_RATE Single rate three color marker as described in RFC 2697. Committed burst packets are counted as green, extended burst packets are @@ -114,24 +114,24 @@ rates are measured in packets per second and bursts are in packets. .Sh CONTROL MESSAGES This node type supports the generic control messages and the following specific messages. -.Bl -tag -width indent -.It Dv NGM_CAR_SET_CONF Pq Li setconf +.Bl -tag -width foo +.It Dv NGM_CAR_SET_CONF Pq Ic setconf Set node configuration to the specified at .Vt "struct ng_car_bulkconf" -.It Dv NGM_CAR_GET_CONF Pq Li getconf +.It Dv NGM_CAR_GET_CONF Pq Ic getconf Return current node configuration as .Vt "struct ng_car_bulkconf" .Bd -literal struct ng_car_hookconf { - uint64_t cbs; /* Committed burst size */ - uint64_t ebs; /* Exceeded/Peak burst size */ - uint64_t cir; /* Committed information rate */ - uint64_t pir; /* Peak information rate */ + uint64_t cbs; /* Commited burst size (bytes) */ + uint64_t ebs; /* Exceeded/Peak burst size (bytes) */ + uint64_t cir; /* Commited information rate (bits/s) */ + uint64_t pir; /* Peak information rate (bits/s) */ uint8_t green_action; /* Action for green packets */ uint8_t yellow_action; /* Action for yellow packets */ uint8_t red_action; /* Action for red packets */ - uint8_t mode; /* operation mode */ - uint8_t opt; /* mode options */ + uint8_t mode; /* single/double rate, ... */ + uint8_t opt; /* color-aware or color-blind */ }; /* possible actions (..._action) */ @@ -156,17 +156,17 @@ struct ng_car_bulkconf { struct ng_car_hookconf downstream; }; .Ed -.It Dv NGM_CAR_GET_STATS Pq Li getstats +.It Dv NGM_CAR_GET_STATS Pq Ic getstats Return node statistics as .Vt "struct ng_car_bulkstats" .Bd -literal struct ng_car_hookstats { - uint64_t passed_pkts; - uint64_t droped_pkts; - uint64_t green_pkts; - uint64_t yellow_pkts; - uint64_t red_pkts; - uint64_t errors; + uint64_t passed_pkts; /* Counter for passed packets */ + uint64_t droped_pkts; /* Counter for droped packets */ + uint64_t green_pkts; /* Counter for green packets */ + uint64_t yellow_pkts; /* Counter for yellow packets */ + uint64_t red_pkts; /* Counter for red packets */ + uint64_t errors; /* Counter for operation errors */ }; struct ng_car_bulkstats { @@ -174,9 +174,9 @@ struct ng_car_bulkstats { struct ng_car_hookstats downstream; }; .Ed -.It Dv NGM_CAR_CLR_STATS Pq Li clrstats +.It Dv NGM_CAR_CLR_STATS Pq Ic clrstats Clear node statistics. -.It Dv NGM_CAR_GETCLR_STATS Pq Li getclrstats +.It Dv NGM_CAR_GETCLR_STATS Pq Ic getclrstats Atomically return and clear node statistics. .El .Sh SHUTDOWN |