| ng_uni.4 (141350) | ng_uni.4 (242997) |
|---|---|
| 1.\" 2.\" Copyright (c) 2001-2003 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Author: Hartmut Brandt <harti@FreeBSD.org> 7.\" 8.\" Redistribution and use in source and binary forms, with or without --- 12 unchanged lines hidden (view full) --- 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" | 1.\" 2.\" Copyright (c) 2001-2003 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Author: Hartmut Brandt <harti@FreeBSD.org> 7.\" 8.\" Redistribution and use in source and binary forms, with or without --- 12 unchanged lines hidden (view full) --- 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" |
| 29.\" $FreeBSD: head/share/man/man4/ng_uni.4 141350 2005-02-05 11:31:31Z ru $ | 29.\" $FreeBSD: head/share/man/man4/ng_uni.4 242997 2012-11-13 20:41:36Z joel $ |
| 30.\" 31.Dd October 6, 2003 32.Dt NG_UNI 4 33.Os 34.Sh NAME 35.Nm ng_uni 36.Nd netgraph UNI node type 37.Sh SYNOPSIS --- 169 unchanged lines hidden (view full) --- 207 UNIAPI_ABORT_CALL_request, /* API -> UNI */ 208 209 UNIAPI_MAXSIG 210}; 211.Ed 212.Pp 213The meaning of most of the signals can be deduced from the ITU-T SDLs. 214A number of signals, however, is unique to this implementation: | 30.\" 31.Dd October 6, 2003 32.Dt NG_UNI 4 33.Os 34.Sh NAME 35.Nm ng_uni 36.Nd netgraph UNI node type 37.Sh SYNOPSIS --- 169 unchanged lines hidden (view full) --- 207 UNIAPI_ABORT_CALL_request, /* API -> UNI */ 208 209 UNIAPI_MAXSIG 210}; 211.Ed 212.Pp 213The meaning of most of the signals can be deduced from the ITU-T SDLs. 214A number of signals, however, is unique to this implementation: |
| 215.Bl -tag -width indent | 215.Bl -tag -width foo |
| 216.It Dv UNIAPI_ERROR 217This is the error response, mentioned earlier. 218It carries an error code or 219zero, if the signal was accepted by the stack. 220.It Dv UNIAPI_CALL_CREATED 221The UNI stack has created a call instance either from an incoming SETUP or 222from the user requesting an outgoing SETUP. 223This may be used to synchronize --- 16 unchanged lines hidden (view full) --- 240.El 241.Pp 242Each of the signals is followed by a fixed size structure defined in 243.In netnatm/sig/unidef.h . 244.Sh CONTROL MESSAGES 245The 246.Nm uni 247node understands the standard control messages, plus the following: | 216.It Dv UNIAPI_ERROR 217This is the error response, mentioned earlier. 218It carries an error code or 219zero, if the signal was accepted by the stack. 220.It Dv UNIAPI_CALL_CREATED 221The UNI stack has created a call instance either from an incoming SETUP or 222from the user requesting an outgoing SETUP. 223This may be used to synchronize --- 16 unchanged lines hidden (view full) --- 240.El 241.Pp 242Each of the signals is followed by a fixed size structure defined in 243.In netnatm/sig/unidef.h . 244.Sh CONTROL MESSAGES 245The 246.Nm uni 247node understands the standard control messages, plus the following: |
| 248.Bl -tag -width indent 249.It Dv NGM_UNI_SETDEBUG | 248.Bl -tag -width foo 249.It Dv NGM_UNI_SETDEBUG Pq Ic setdebug |
| 250Set debugging facility levels. 251The UNI stack defines a number of debugging 252facilities, each one associated with a debugging level. 253If the debugging level 254of a facility is non-zero, text output will be generated to the console. 255The message uses the following structure: 256.Bd -literal 257struct ngm_uni_debug { 258 uint32_t level[UNI_MAXFACILITY]; 259}; 260.Ed | 250Set debugging facility levels. 251The UNI stack defines a number of debugging 252facilities, each one associated with a debugging level. 253If the debugging level 254of a facility is non-zero, text output will be generated to the console. 255The message uses the following structure: 256.Bd -literal 257struct ngm_uni_debug { 258 uint32_t level[UNI_MAXFACILITY]; 259}; 260.Ed |
| 261.It Dv NGM_UNI_SETDEBUG | 261.It Dv NGM_UNI_GETDEBUG Pq Ic getdebug |
| 262Get debugging facility levels. 263This returns an 264.Vt ngm_uni_debug 265structure. | 262Get debugging facility levels. 263This returns an 264.Vt ngm_uni_debug 265structure. |
| 266.It Dv NGM_UNI_GET_CONFIG | 266.It Dv NGM_UNI_GET_CONFIG Pq Ic get_config |
| 267Retrieve the current configuration of the UNI instance. 268This message returns a 269.Vt uni_config 270structure: 271.Bd -literal 272struct uni_config { 273 uint32_t proto; /* which protocol */ 274 uint32_t popt; /* protocol option */ --- 46 unchanged lines hidden (view full) --- 321 UNIOPT_CAUSE_HARD, /* harder check of CAUSE IE */ 322}; 323.Ed 324.Pp 325All timer values are given in milliseconds. 326Note, however, that the actual 327resolution of the timers depend on system configuration (see 328.Xr timeout 9 ) . | 267Retrieve the current configuration of the UNI instance. 268This message returns a 269.Vt uni_config 270structure: 271.Bd -literal 272struct uni_config { 273 uint32_t proto; /* which protocol */ 274 uint32_t popt; /* protocol option */ --- 46 unchanged lines hidden (view full) --- 321 UNIOPT_CAUSE_HARD, /* harder check of CAUSE IE */ 322}; 323.Ed 324.Pp 325All timer values are given in milliseconds. 326Note, however, that the actual 327resolution of the timers depend on system configuration (see 328.Xr timeout 9 ) . |
| 329.It Dv NGM_UNI_SET_CONFIG | 329.It Dv NGM_UNI_SET_CONFIG Pq Ic set_config |
| 330Change the UNI configuration. 331This takes a 332.Bd -literal 333struct ngm_uni_set_config { 334 struct uni_config config; 335 struct ngm_uni_config_mask mask; 336}; 337struct ngm_uni_config_mask { --- 43 unchanged lines hidden (view full) --- 381.Va popt_mask 382and 383.Va option_mask , 384the definitions from 385.Vt "enum uni_popt" 386and 387.Vt "enum uni_option" 388should be used. | 330Change the UNI configuration. 331This takes a 332.Bd -literal 333struct ngm_uni_set_config { 334 struct uni_config config; 335 struct ngm_uni_config_mask mask; 336}; 337struct ngm_uni_config_mask { --- 43 unchanged lines hidden (view full) --- 381.Va popt_mask 382and 383.Va option_mask , 384the definitions from 385.Vt "enum uni_popt" 386and 387.Vt "enum uni_option" 388should be used. |
| 389.It Dv NGM_UNI_ENABLE | 389.It Dv NGM_UNI_ENABLE Pq Ic enable |
| 390Create the UNI instance and enable processing. 391Before the UNI is enabled parameters cannot be retrieved or set. | 390Create the UNI instance and enable processing. 391Before the UNI is enabled parameters cannot be retrieved or set. |
| 392.It Dv NGM_UNI_DISABLE | 392.It Dv NGM_UNI_DISABLE Pq Ic disable |
| 393Destroy the UNI instance and free all resources. 394Note, that connections are not released. 395.El 396.Sh SEE ALSO 397.Xr netgraph 4 , 398.Xr ng_atm 4 , 399.Xr ng_sscfu 4 , 400.Xr ng_sscop 4 , --- 20 unchanged lines hidden --- | 393Destroy the UNI instance and free all resources. 394Note, that connections are not released. 395.El 396.Sh SEE ALSO 397.Xr netgraph 4 , 398.Xr ng_atm 4 , 399.Xr ng_sscfu 4 , 400.Xr ng_sscop 4 , --- 20 unchanged lines hidden --- |