| ng_ccatm.4 (231564) | ng_ccatm.4 (242997) |
|---|---|
| 1.\" 2.\" Copyright (c) 2001-2004 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" Copyright (c) 2005 6.\" Hartmut Brandt. 7.\" All rights reserved. 8.\" --- 15 unchanged lines hidden (view full) --- 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" | 1.\" 2.\" Copyright (c) 2001-2004 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" Copyright (c) 2005 6.\" Hartmut Brandt. 7.\" All rights reserved. 8.\" --- 15 unchanged lines hidden (view full) --- 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" |
| 32.\" $FreeBSD: head/share/man/man4/ng_ccatm.4 231564 2012-02-12 18:29:56Z ed $ | 32.\" $FreeBSD: head/share/man/man4/ng_ccatm.4 242997 2012-11-13 20:41:36Z joel $ |
| 33.\" 34.Dd March 10, 2005 35.Dt NG_CCATM 4 36.Os 37.Sh NAME 38.Nm ng_ccatm 39.Nd "ATM Call Control netgraph node type" 40.Sh SYNOPSIS --- 100 unchanged lines hidden (view full) --- 141 ATMOP_SET_CONNECTION_ATTRIBUTES_X, 142 ATMOP_QUERY_CONNECTION_ATTRIBUTES_X, 143 ATMOP_QUERY_STATE 144}; 145.Ed 146.Pp 147These codes correspond directly to the operations specified in the ATM 148Forum document with the following exceptions: | 33.\" 34.Dd March 10, 2005 35.Dt NG_CCATM 4 36.Os 37.Sh NAME 38.Nm ng_ccatm 39.Nd "ATM Call Control netgraph node type" 40.Sh SYNOPSIS --- 100 unchanged lines hidden (view full) --- 141 ATMOP_SET_CONNECTION_ATTRIBUTES_X, 142 ATMOP_QUERY_CONNECTION_ATTRIBUTES_X, 143 ATMOP_QUERY_STATE 144}; 145.Ed 146.Pp 147These codes correspond directly to the operations specified in the ATM 148Forum document with the following exceptions: |
| 149.Bl -tag -width indent | 149.Bl -tag -width foo |
| 150.It Dv ATMOP_RESP 151As discussed in 152.Xr ng_uni 4 , 153this is used to 154.Dq synchronify 155the interface. 156The argument is a 157.Bd -literal --- 28 unchanged lines hidden (view full) --- 186.El 187.Pp 188If a user hook is disconnected, an active connection on that hook is released. 189Incoming connections waiting to be accepted are reoffered to other 190listening hooks or rejected. 191.Sh CONTROL MESSAGES 192Besides the generic messages the node understands the following special 193messages: | 150.It Dv ATMOP_RESP 151As discussed in 152.Xr ng_uni 4 , 153this is used to 154.Dq synchronify 155the interface. 156The argument is a 157.Bd -literal --- 28 unchanged lines hidden (view full) --- 186.El 187.Pp 188If a user hook is disconnected, an active connection on that hook is released. 189Incoming connections waiting to be accepted are reoffered to other 190listening hooks or rejected. 191.Sh CONTROL MESSAGES 192Besides the generic messages the node understands the following special 193messages: |
| 194.Bl -tag -width indent 195.It Dv NGM_CCATM_DUMP | 194.Bl -tag -width foo 195.It Dv NGM_CCATM_DUMP Pq Ic dump |
| 196This causes the internal state of the node to be dumped in ASCII to the 197.Va dump 198hook. | 196This causes the internal state of the node to be dumped in ASCII to the 197.Va dump 198hook. |
| 199.It Dv NGM_CCATM_STOP | 199.It Dv NGM_CCATM_STOP Pq Ic stop |
| 200This message causes all connections on that port to be aborted (not released!\&) 201and all ATM endpoints which are bound to that port to be closed. 202It stops processing of all messages from the UNI stack on that port UNI stack. 203The argument is a 204.Bd -literal 205struct ngm_ccatm_port { 206 uint32_t port; 207}; 208.Ed 209.Pp | 200This message causes all connections on that port to be aborted (not released!\&) 201and all ATM endpoints which are bound to that port to be closed. 202It stops processing of all messages from the UNI stack on that port UNI stack. 203The argument is a 204.Bd -literal 205struct ngm_ccatm_port { 206 uint32_t port; 207}; 208.Ed 209.Pp |
| 210.It Dv NGM_CCATM_START | 210.It Dv NGM_CCATM_START Pq Ic start |
| 211Start processing on the port. 212The argument is a 213.Vt ngm_ccatm_port 214structure. | 211Start processing on the port. 212The argument is a 213.Vt ngm_ccatm_port 214structure. |
| 215.It Dv NGM_CCATM_CLEAR | 215.It Dv NGM_CCATM_CLEAR Pq Ic clear |
| 216This message takes a 217.Vt ngm_ccatm_port 218structure and clears all prefixes and addresses on that port. 219If the port number is zero, all ports are cleared. | 216This message takes a 217.Vt ngm_ccatm_port 218structure and clears all prefixes and addresses on that port. 219If the port number is zero, all ports are cleared. |
| 220.It Dv NGM_CCATM_GET_ADDRESSES | 220.It Dv NGM_CCATM_GET_ADDRESSES Pq Ic get_addresses |
| 221Get the list of all registered addresses on the given port. 222The argument is a 223.Vt ngm_ccatm_port 224structure and the result is a 225.Vt ngm_ccatm_get_addresses 226structure: 227.Bd -literal 228struct ngm_ccatm_get_addresses { --- 9 unchanged lines hidden (view full) --- 238If the 239.Va port 240field is zero in the request, all addresses on all ports 241are returned. 242If it is not zero, only the addresses on that port are reported. 243The number of addresses is returned in the 244.Va count 245field. | 221Get the list of all registered addresses on the given port. 222The argument is a 223.Vt ngm_ccatm_port 224structure and the result is a 225.Vt ngm_ccatm_get_addresses 226structure: 227.Bd -literal 228struct ngm_ccatm_get_addresses { --- 9 unchanged lines hidden (view full) --- 238If the 239.Va port 240field is zero in the request, all addresses on all ports 241are returned. 242If it is not zero, only the addresses on that port are reported. 243The number of addresses is returned in the 244.Va count 245field. |
| 246.It Dv NGM_CCATM_ADDRESS_REGISTERED | 246.It Dv NGM_CCATM_ADDRESS_REGISTERED Pq Ic address_reg |
| 247This message is used by ILMI to inform the 248.Nm 249node that a previous address registration request was successful. 250This causes the node to activate that address. 251The argument to the message is a 252.Vt ngm_ccatm_address_req 253structure. | 247This message is used by ILMI to inform the 248.Nm 249node that a previous address registration request was successful. 250This causes the node to activate that address. 251The argument to the message is a 252.Vt ngm_ccatm_address_req 253structure. |
| 254.It Dv NGM_CCATM_ADDRESS_UNREGISTERED | 254.It Dv NGM_CCATM_ADDRESS_UNREGISTERED Pq Ic address_unreg |
| 255This message is used by ILMI to inform the 256.Nm 257node that an address has been unregistered. 258The node clears that address from its tables. 259The argument is a 260.Vt ngm_ccatm_address_req 261structure. | 255This message is used by ILMI to inform the 256.Nm 257node that an address has been unregistered. 258The node clears that address from its tables. 259The argument is a 260.Vt ngm_ccatm_address_req 261structure. |
| 262.It Dv NGM_CCATM_SET_PORT_PARAM | 262.It Dv NGM_CCATM_SET_PORT_PARAM Pq Ic set_port_param |
| 263This request sets the parameters on the given port. 264The argument is a 265.Bd -literal 266struct ngm_ccatm_atm_port { 267 uint32_t port; /* port for which to set parameters */ 268 uint32_t pcr; /* port peak cell rate */ 269 uint32_t max_vpi_bits; 270 uint32_t max_vci_bits; --- 5 unchanged lines hidden (view full) --- 276}; 277.Ed 278.Pp 279This should be used only by ILMI and when that port is stopped and the 280address and prefix tables of that port are empty. 281The 282.Va num_addr 283field is ignored. | 263This request sets the parameters on the given port. 264The argument is a 265.Bd -literal 266struct ngm_ccatm_atm_port { 267 uint32_t port; /* port for which to set parameters */ 268 uint32_t pcr; /* port peak cell rate */ 269 uint32_t max_vpi_bits; 270 uint32_t max_vci_bits; --- 5 unchanged lines hidden (view full) --- 276}; 277.Ed 278.Pp 279This should be used only by ILMI and when that port is stopped and the 280address and prefix tables of that port are empty. 281The 282.Va num_addr 283field is ignored. |
| 284.It Dv NGM_CCATM_GET_PORT_PARAM | 284.It Dv NGM_CCATM_GET_PORT_PARAM Pq Ic get_port_param |
| 285Retrieve the parameters of the given port. 286The argument is a 287.Vt ngm_ccatm_port 288and the result a 289.Vt ngm_ccatm_atm_port . | 285Retrieve the parameters of the given port. 286The argument is a 287.Vt ngm_ccatm_port 288and the result a 289.Vt ngm_ccatm_atm_port . |
| 290.It Dv NGM_CCATM_GET_PORTLIST | 290.It Dv NGM_CCATM_GET_PORTLIST Pq Ic get_portlist |
| 291Get a list of all available ports on that node. 292This is returned as a 293.Bd -literal 294struct ngm_ccatm_portlist { 295 uint32_t nports; 296 uint32_t ports[]; 297}; 298.Ed | 291Get a list of all available ports on that node. 292This is returned as a 293.Bd -literal 294struct ngm_ccatm_portlist { 295 uint32_t nports; 296 uint32_t ports[]; 297}; 298.Ed |
| 299.It Dv NGM_CCATM_GETSTATE | 299.It Dv NGM_CCATM_GETSTATE Pq Ic getstate |
| 300Return the state of a port. 301The argument is a 302.Vt "struct ngm_ccatm_port" 303and the return values as a 304.Vt uint32_t . | 300Return the state of a port. 301The argument is a 302.Vt "struct ngm_ccatm_port" 303and the return values as a 304.Vt uint32_t . |
| 305.It Dv NGM_CCATM_SETLOG | 305.It Dv NGM_CCATM_SETLOG Pq Ic setlog |
| 306This requests sets a new logging level and returns the previous one. 307The argument is either a 308.Vt uint32_t 309in which case it specifies the new logging level, or may be empty 310in which case just the old level is returned as a 311.Vt uint32_t . | 306This requests sets a new logging level and returns the previous one. 307The argument is either a 308.Vt uint32_t 309in which case it specifies the new logging level, or may be empty 310in which case just the old level is returned as a 311.Vt uint32_t . |
| 312.It Dv NGM_CCATM_RESET | 312.It Dv NGM_CCATM_RESET Pq Ic reset |
| 313Reset the node. 314This is allowed only if the number of user hooks and connected UNI stacks is 315zero. 316.It Dv NGM_CCATM_GET_EXSTAT 317Return extended status information from the node. 318.El 319.Sh SEE ALSO 320.Xr netgraph 4 , 321.Xr ng_uni 4 , 322.Xr ngctl 8 323.Sh AUTHORS 324.An Harti Brandt Aq harti@FreeBSD.org | 313Reset the node. 314This is allowed only if the number of user hooks and connected UNI stacks is 315zero. 316.It Dv NGM_CCATM_GET_EXSTAT 317Return extended status information from the node. 318.El 319.Sh SEE ALSO 320.Xr netgraph 4 , 321.Xr ng_uni 4 , 322.Xr ngctl 8 323.Sh AUTHORS 324.An Harti Brandt Aq harti@FreeBSD.org |