| ng_sscop.4 (140568) | ng_sscop.4 (242997) |
|---|---|
| 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 140568 2005-01-21 10:48:35Z ru $ | 29.\" $FreeBSD: head/share/man/man4/ng_sscop.4 242997 2012-11-13 20:41:36Z joel $ |
| 30.\" 31.\" ng_sscop(4) man page 32.\" 33.Dd October 24, 2003 34.Dt NG_SSCOP 4 35.Os 36.Sh NAME 37.Nm ng_sscop --- 161 unchanged lines hidden (view full) --- 199 uint32_t cnt; /* error count */ 200}; 201.Ed 202.El 203.Sh CONTROL MESSAGES 204The 205.Nm sscop 206node understands the generic control messages, plus the following: | 30.\" 31.\" ng_sscop(4) man page 32.\" 33.Dd October 24, 2003 34.Dt NG_SSCOP 4 35.Os 36.Sh NAME 37.Nm ng_sscop --- 161 unchanged lines hidden (view full) --- 199 uint32_t cnt; /* error count */ 200}; 201.Ed 202.El 203.Sh CONTROL MESSAGES 204The 205.Nm sscop 206node understands the generic control messages, plus the following: |
| 207.Bl -tag -width indent 208.It Dv NGM_SSCOP_SETPARAM | 207.Bl -tag -width foo 208.It Dv NGM_SSCOP_SETPARAM Pq Ic setparam |
| 209Sets operational parameters of the SSCOP instance and takes the 210following structure: 211.Bd -literal 212struct ng_sscop_setparam { 213 uint32_t mask; 214 struct sscop_param param; 215}; 216.Ed --- 90 unchanged lines hidden (view full) --- 307Here 308.Va mask 309contains a bitmask of the parameters that the user requested to set, 310but that could not be set and 311.Va error 312is an 313.Xr errno 2 314code describing why the parameter could not be set. | 209Sets operational parameters of the SSCOP instance and takes the 210following structure: 211.Bd -literal 212struct ng_sscop_setparam { 213 uint32_t mask; 214 struct sscop_param param; 215}; 216.Ed --- 90 unchanged lines hidden (view full) --- 307Here 308.Va mask 309contains a bitmask of the parameters that the user requested to set, 310but that could not be set and 311.Va error 312is an 313.Xr errno 2 314code describing why the parameter could not be set. |
| 315.It Dv NGM_SSCOP_GETPARAM | 315.It Dv NGM_SSCOP_GETPARAM Pq Ic getparam |
| 316This message returns the current operational parameters of the SSCOP 317instance in a 318.Vt sscop_param 319structure. | 316This message returns the current operational parameters of the SSCOP 317instance in a 318.Vt sscop_param 319structure. |
| 320.It Dv NGM_SSCOP_ENABLE | 320.It Dv NGM_SSCOP_ENABLE Pq Ic enable |
| 321This message creates the actual SSCOP instance and initializes it. 322Until this is done, parameters may neither be retrieved nor set, and all 323messages received on any hook are discarded. | 321This message creates the actual SSCOP instance and initializes it. 322Until this is done, parameters may neither be retrieved nor set, and all 323messages received on any hook are discarded. |
| 324.It Dv NGM_SSCOP_DISABLE | 324.It Dv NGM_SSCOP_DISABLE Pq Ic disable |
| 325Destroy the SSCOP instance. 326After this, all messages on any hooks are 327discarded. | 325Destroy the SSCOP instance. 326After this, all messages on any hooks are 327discarded. |
| 328.It Dv NGM_SSCOP_SETDEBUG | 328.It Dv NGM_SSCOP_SETDEBUG Pq Ic setdebug |
| 329Set debugging flags. 330The argument is a 331.Vt uint32_t . | 329Set debugging flags. 330The argument is a 331.Vt uint32_t . |
| 332.It Dv NGM_SSCOP_GETDEBUG | 332.It Dv NGM_SSCOP_GETDEBUG Pq Ic getdebug |
| 333Retrieve the actual debugging flags. 334Needs no arguments and responds with a 335.Vt uint32_t . | 333Retrieve the actual debugging flags. 334Needs no arguments and responds with a 335.Vt uint32_t . |
| 336.It Dv NGM_SSCOP_GETSTATE | 336.It Dv NGM_SSCOP_GETSTATE Pq Ic getstate |
| 337Responds with the current state of the SSCOP instance in a 338.Vt uint32_t . 339If the node is not enabled, the retrieved state is 0. 340.El 341.Sh FLOW CONTROL 342Flow control works on the upper and on the lower layer interface. 343At the lower 344layer interface, the two messages, 345.Dv NGM_HIGH_WATER_PASSED 346and 347.Dv NGM_LOW_WATER_PASSED , 348are used to declare or clear the 349.Dq "lower layer busy" 350state of the protocol. 351.Pp 352At the upper layer interface, the 353.Nm sscop 354node handles three types of flow control messages: | 337Responds with the current state of the SSCOP instance in a 338.Vt uint32_t . 339If the node is not enabled, the retrieved state is 0. 340.El 341.Sh FLOW CONTROL 342Flow control works on the upper and on the lower layer interface. 343At the lower 344layer interface, the two messages, 345.Dv NGM_HIGH_WATER_PASSED 346and 347.Dv NGM_LOW_WATER_PASSED , 348are used to declare or clear the 349.Dq "lower layer busy" 350state of the protocol. 351.Pp 352At the upper layer interface, the 353.Nm sscop 354node handles three types of flow control messages: |
| 355.Bl -tag -width indent | 355.Bl -tag -width foo |
| 356.It Dv NGM_HIGH_WATER_PASSED 357If this message is received, the SSCOP stops moving the receive window. 358Each time a data message is handed over to the upper layer, the receive 359window is moved by one message. 360Stopping these updates 361means that the window will start to close and if the peer has sent 362all messages allowed by the current window, it stops transmission. 363This means that the upper layer must be able to still receive a full window --- 40 unchanged lines hidden --- | 356.It Dv NGM_HIGH_WATER_PASSED 357If this message is received, the SSCOP stops moving the receive window. 358Each time a data message is handed over to the upper layer, the receive 359window is moved by one message. 360Stopping these updates 361means that the window will start to close and if the peer has sent 362all messages allowed by the current window, it stops transmission. 363This means that the upper layer must be able to still receive a full window --- 40 unchanged lines hidden --- |