| ng_sscop.4 (131472) | ng_sscop.4 (131530) |
|---|---|
| 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 131472 2004-07-02 19:07:33Z ru $ | 29.\" $FreeBSD: head/share/man/man4/ng_sscop.4 131530 2004-07-03 18:29:24Z 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 38.Nd netgraph SSCOP node type 39.Sh SYNOPSIS 40.Fd #include <netnatm/saal/sscopdef.h> 41.Fd #include <netgraph/atm/ng_sscop.h> 42.Sh DESCIPTION 43The 44.Nm | 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 38.Nd netgraph SSCOP node type 39.Sh SYNOPSIS 40.Fd #include <netnatm/saal/sscopdef.h> 41.Fd #include <netgraph/atm/ng_sscop.h> 42.Sh DESCIPTION 43The 44.Nm |
| 45netgraph node implements the ITU-T standard Q.2110. This standard describes | 45netgraph node implements the ITU-T standard Q.2110. 46This standard describes |
| 46the so called Service Specific Connection Oriented Protocol (SSCOP) that 47is used to carry signalling messages over the private and public UNIs and 48the public NNI. 49This protocol is a transport protocol with selective 50acknowledgements and can be tailored to the environment. 51This implementation is a full implementation of that standard. 52.Pp 53After creation of the node, the SSCOP instance must be created by sending --- 6 unchanged lines hidden (view full) --- 60message or when all hooks are disconnected. 61.Sh HOOKS 62Each 63.Nm 64node has three hooks with fixed names: 65.Bl -tag -width manage 66.It Dv lower 67This hook is the hook that must be connected to a node that ensures | 47the so called Service Specific Connection Oriented Protocol (SSCOP) that 48is used to carry signalling messages over the private and public UNIs and 49the public NNI. 50This protocol is a transport protocol with selective 51acknowledgements and can be tailored to the environment. 52This implementation is a full implementation of that standard. 53.Pp 54After creation of the node, the SSCOP instance must be created by sending --- 6 unchanged lines hidden (view full) --- 61message or when all hooks are disconnected. 62.Sh HOOKS 63Each 64.Nm 65node has three hooks with fixed names: 66.Bl -tag -width manage 67.It Dv lower 68This hook is the hook that must be connected to a node that ensures |
| 68transport of packets to and from the remote peer node. Normally this is a | 69transport of packets to and from the remote peer node. 70Normally this is a |
| 69.Xr ng_atm 4 70node with an AAL5 hook, but the 71.Nm 72node is able to work on any packet-transporting layer, like, for example, 73IP or UDP. 74The node handles flow control messages received on 75this hook: if it receives a 76.Dv NGM_HIGH_WATER_PASSED --- 196 unchanged lines hidden (view full) --- 273instance in a 274.Fa sscop_param 275structure. 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. 280.It Dv NGM_SSCOP_DISABLE | 71.Xr ng_atm 4 72node with an AAL5 hook, but the 73.Nm 74node is able to work on any packet-transporting layer, like, for example, 75IP or UDP. 76The node handles flow control messages received on 77this hook: if it receives a 78.Dv NGM_HIGH_WATER_PASSED --- 196 unchanged lines hidden (view full) --- 275instance in a 276.Fa sscop_param 277structure. 278.It Dv NGM_SSCOP_ENABLE 279This message creates the actual SSCOP instance and initializes it. 280Until this is done, parameters may neither be retrieved not set and all 281message received on any hook are discarded. 282.It Dv NGM_SSCOP_DISABLE |
| 281Destroy the SSCOP instance. After this all messages on any hooks are | 283Destroy the SSCOP instance. 284After this all messages on any hooks are |
| 282discarded. 283.It Dv NGM_SSCOP_SETDEBUG | 285discarded. 286.It Dv NGM_SSCOP_SETDEBUG |
| 284Set debugging flags. The argument is an | 287Set debugging flags. 288The 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 289.Vt uint32_t . 290.It Dv NGM_SSCOP_GETSTATE 291Responds with the current state of the SSCOP instance in an 292.Vt uint32_t . 293If the node is not enabled the retrieved state is 0. 294.El 295.Sh FLOW CONTROL | 289.Vt uint32_t . 290.It Dv NGM_SSCOP_GETDEBUG 291Retrieve the actual debugging flags. 292Needs no arguments and responds with an 293.Vt uint32_t . 294.It Dv NGM_SSCOP_GETSTATE 295Responds with the current state of the SSCOP instance in an 296.Vt uint32_t . 297If the node is not enabled the retrieved state is 0. 298.El 299.Sh FLOW CONTROL |
| 296Flow control works on the upper and on the lower layer interface. At the lower | 300Flow control works on the upper and on the lower layer interface. 301At the lower |
| 297layer interface the two messages 298.Dv NGM_HIGH_WATER_PASSED 299and 300.Dv NGM_LOW_WATER_PASSED 301are used to declare or clear the 302.Ql lower layer busy 303state of the protocol. 304.Pp --- 51 unchanged lines hidden --- | 302layer interface the two messages 303.Dv NGM_HIGH_WATER_PASSED 304and 305.Dv NGM_LOW_WATER_PASSED 306are used to declare or clear the 307.Ql lower layer busy 308state of the protocol. 309.Pp --- 51 unchanged lines hidden --- |