| ng_sscop.4 (123943) | ng_sscop.4 (131472) |
|---|---|
| 1.\" 2.\" Copyright (c) 2001-2003 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: --- 12 unchanged lines hidden (view full) --- 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" Author: Hartmut Brandt <harti@freebsd.org> 28.\" | 1.\" 2.\" Copyright (c) 2001-2003 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: --- 12 unchanged lines hidden (view full) --- 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" Author: Hartmut Brandt <harti@freebsd.org> 28.\" |
| 29.\" $FreeBSD: head/share/man/man4/ng_sscop.4 123943 2003-12-28 22:34:47Z ru $ | 29.\" $FreeBSD: head/share/man/man4/ng_sscop.4 131472 2004-07-02 19:07:33Z ru $ |
| 30.\" 31.\" ng_sscop(4) man page 32.\" 33.Dd October 24, 2003 34.Dt NG_SSCOP 4 35.Os FreeBSD 36.Sh NAME 37.Nm ng_sscop --- 110 unchanged lines hidden (view full) --- 148.Dv SSCOP_DATA_request ) 149these two fields are followed by the variable sized user data. 150.Pp 151If the upper hook is disconnected and the SSCOP instance is not in the idle 152state and the lower hook is still connected, an 153.Dv SSCOP_RELEASE_request 154is executed to release the SSCOP connection. 155.It Dv manage | 30.\" 31.\" ng_sscop(4) man page 32.\" 33.Dd October 24, 2003 34.Dt NG_SSCOP 4 35.Os FreeBSD 36.Sh NAME 37.Nm ng_sscop --- 110 unchanged lines hidden (view full) --- 148.Dv SSCOP_DATA_request ) 149these two fields are followed by the variable sized user data. 150.Pp 151If the upper hook is disconnected and the SSCOP instance is not in the idle 152state and the lower hook is still connected, an 153.Dv SSCOP_RELEASE_request 154is executed to release the SSCOP connection. 155.It Dv manage |
| 156This is the management interface defined in the standard. | 156This is the management interface defined in the standard. |
| 157The data structure used here is: 158.Bd -literal 159struct sscop_marg { 160 uint32_t sig; 161 u_char data[]; 162}; 163.Ed 164.Pp --- 20 unchanged lines hidden (view full) --- 185 uint32_t cnt; /* error count */ 186}; 187.Ed 188.Sh CONTROL MESSAGES 189The 190.Nm 191node understands the generic messages plus the following: 192.Bl -tag -width xxx | 157The data structure used here is: 158.Bd -literal 159struct sscop_marg { 160 uint32_t sig; 161 u_char data[]; 162}; 163.Ed 164.Pp --- 20 unchanged lines hidden (view full) --- 185 uint32_t cnt; /* error count */ 186}; 187.Ed 188.Sh CONTROL MESSAGES 189The 190.Nm 191node understands the generic messages plus the following: 192.Bl -tag -width xxx |
| 193.It Dv NGM_SSCOP_SETPARAM | 193.It Dv NGM_SSCOP_SETPARAM |
| 194Set operational parameters of the SSCOP instance and takes the 195following structure: 196.Bd -literal 197struct ng_sscop_setparam { 198 uint32_t mask; 199 struct sscop_param param; 200}; 201.Ed --- 61 unchanged lines hidden (view full) --- 263Here 264.Dv mask 265contains the a bitmask of the parameters that the user requested to set, 266but that could not be set and 267.Dv error 268is an 269.Xr errno 3 270code describing why the parameter could not be set. | 194Set operational parameters of the SSCOP instance and takes the 195following structure: 196.Bd -literal 197struct ng_sscop_setparam { 198 uint32_t mask; 199 struct sscop_param param; 200}; 201.Ed --- 61 unchanged lines hidden (view full) --- 263Here 264.Dv mask 265contains the a bitmask of the parameters that the user requested to set, 266but that could not be set and 267.Dv error 268is an 269.Xr errno 3 270code describing why the parameter could not be set. |
| 271.It Dv NGM_SSCOP_GETPARAM | 271.It Dv NGM_SSCOP_GETPARAM |
| 272This message returns the current operational parameters of the SSCOP 273instance in a 274.Fa sscop_param 275structure. | 272This message returns the current operational parameters of the SSCOP 273instance in a 274.Fa sscop_param 275structure. |
| 276.It Dv NGM_SSCOP_ENABLE | 276.It Dv NGM_SSCOP_ENABLE |
| 277This message creates the actual SSCOP instance and initializes it. 278Until this is done, parameters may neither be retrieved not set and all 279message received on any hook are discarded. | 277This message creates the actual SSCOP instance and initializes it. 278Until this is done, parameters may neither be retrieved not set and all 279message received on any hook are discarded. |
| 280.It Dv NGM_SSCOP_DISABLE | 280.It Dv NGM_SSCOP_DISABLE |
| 281Destroy the SSCOP instance. After this all messages on any hooks are 282discarded. 283.It Dv NGM_SSCOP_SETDEBUG 284Set debugging flags. The argument is an 285.Vt uint32_t . 286.It Dv NGM_SSCOP_GETDEBUG 287Retrieve the actual debugging flags. 288Needs no arguments and responds with an --- 29 unchanged lines hidden (view full) --- 318.It Dv NGM_LOW_WATER_PASSED 319This will re-enable the automatic window updates and if the space indicated 320in the message is larger than the current window, the window will be opened 321by that amount. 322The space is computed as the difference of the 323.Fa max_queuelen_packets 324and 325.Fa current | 281Destroy the SSCOP instance. After this all messages on any hooks are 282discarded. 283.It Dv NGM_SSCOP_SETDEBUG 284Set debugging flags. The argument is an 285.Vt uint32_t . 286.It Dv NGM_SSCOP_GETDEBUG 287Retrieve the actual debugging flags. 288Needs no arguments and responds with an --- 29 unchanged lines hidden (view full) --- 318.It Dv NGM_LOW_WATER_PASSED 319This will re-enable the automatic window updates and if the space indicated 320in the message is larger than the current window, the window will be opened 321by that amount. 322The space is computed as the difference of the 323.Fa max_queuelen_packets 324and 325.Fa current |
| 326members of the | 326members of the |
| 327.Fa ngm_queue_state 328structure. 329.It Dv NGM_SYNC_QUEUE_STATE 330If the upper layer buffer filling state as indicated by 331.Fa current 332is equal too or higher than 333.Fa high_watermark 334than the message is ignored. --- 21 unchanged lines hidden --- | 327.Fa ngm_queue_state 328structure. 329.It Dv NGM_SYNC_QUEUE_STATE 330If the upper layer buffer filling state as indicated by 331.Fa current 332is equal too or higher than 333.Fa high_watermark 334than the message is ignored. --- 21 unchanged lines hidden --- |