Fix some spelling errors.
This commit is contained in:
parent
c66c86f451
commit
7f9d26bd9d
@ -298,7 +298,7 @@ This is the entry point called when a data message is being handed to
|
||||
the node after having been queued in the NETISR system.
|
||||
This allows a node to decide in the
|
||||
.Em Receive data message
|
||||
method that a message should be defered and queued,
|
||||
method that a message should be deferred and queued,
|
||||
and be sure that when it is processed from the queue,
|
||||
it will not be queued again.
|
||||
.It Receive control message
|
||||
@ -347,7 +347,7 @@ A relative address includes only the sequence of hook names, implicitly
|
||||
starting hook traversal at the local node.
|
||||
.Pp
|
||||
There are a couple of special possibilities for the node name.
|
||||
The name ``.'' (refered to as ``.:'') always refers to the local node.
|
||||
The name ``.'' (referred to as ``.:'') always refers to the local node.
|
||||
Also, nodes that have no global name may be addressed by their ID numbers,
|
||||
by enclosing the hex representation of the ID number within square brackets.
|
||||
Here are some examples of valid netgraph addresses:
|
||||
@ -569,7 +569,7 @@ supplied hook names.
|
||||
.It Dv NGM_SHUTDOWN
|
||||
The target node should disconnect from all its neighbours and shut down.
|
||||
Persistent nodes such as those representing physical hardware
|
||||
might not dissappear from the node namespace, but only reset themselves.
|
||||
might not disappear from the node namespace, but only reset themselves.
|
||||
The node must disconnect all of its hooks.
|
||||
This may result in neighbors shutting themselves down, and possibly a
|
||||
cascading shutdown of the entire connected graph.
|
||||
@ -590,7 +590,7 @@ number of hooks attached. The ID is an internal number unique to that node.
|
||||
This returns the information given by
|
||||
.Dv NGM_NODEINFO ,
|
||||
but in addition
|
||||
includes an array of fields describing each link, and the desription for
|
||||
includes an array of fields describing each link, and the description for
|
||||
the node at the far end of that link.
|
||||
.It Dv NGM_LISTNAMES
|
||||
This returns an array of node descriptions (as for
|
||||
@ -619,7 +619,7 @@ Data moving through the
|
||||
system can be accompanied by meta-data that describes some
|
||||
aspect of that data. The form of the meta-data is a fixed header,
|
||||
which contains enough information for most uses, and can optionally
|
||||
be suplemented by trailing
|
||||
be supplemented by trailing
|
||||
.Em option
|
||||
structures, which contain a
|
||||
.Em cookie
|
||||
@ -747,7 +747,7 @@ for each DLCI.
|
||||
.It FRAME RELAY LMI
|
||||
Automatically handles frame relay
|
||||
``LMI'' (link management interface) operations and packets.
|
||||
Automatically probes and detects whch of several LMI standards
|
||||
Automatically probes and detects which of several LMI standards
|
||||
is in use at the exchange.
|
||||
.Pp
|
||||
.It TTY
|
||||
@ -770,7 +770,7 @@ The interfaces are named
|
||||
etc.
|
||||
.El
|
||||
.Sh NOTES
|
||||
Whether a named node exists can be checked by trying to send a control mesage
|
||||
Whether a named node exists can be checked by trying to send a control message
|
||||
to it (e.g.,
|
||||
.Dv NGM_NODEINFO
|
||||
).
|
||||
@ -786,7 +786,7 @@ There are three exceptions:
|
||||
.It 1
|
||||
Mbufs sent across a data link are never to be freed by the sender.
|
||||
.It 2
|
||||
Any meta-data information travelling with the data has the same restriction.
|
||||
Any meta-data information traveling with the data has the same restriction.
|
||||
It might be freed by any node the data passes through, and a
|
||||
.Dv NULL
|
||||
passed onwards, but the caller will never free it.
|
||||
@ -806,7 +806,7 @@ recipient should copy them if it wants to keep that information.
|
||||
.Sh FILES
|
||||
.Bl -tag -width xxxxx -compact
|
||||
.It Pa /sys/netgraph/netgraph.h
|
||||
Definitions for use soley within the kernel by
|
||||
Definitions for use solely within the kernel by
|
||||
.Nm
|
||||
nodes.
|
||||
.It Pa /sys/netgraph/ng_message.h
|
||||
|
@ -52,7 +52,7 @@ Asynchronous framing uses flag bytes and octet-stuffing
|
||||
to simulate a frame oriented connection over an octet-oriented
|
||||
asynchronous line.
|
||||
.Pp
|
||||
The node trasmits and receives asynchronous data on the
|
||||
The node transmits and receives asynchronous data on the
|
||||
.Dv async
|
||||
hook. Incoming data mbuf boundaries are ignored, while
|
||||
outgoing data is sent as a complete frame at a time.
|
||||
|
@ -70,7 +70,7 @@ type node.
|
||||
In order to function properly for IP traffic, the node must be informed
|
||||
of the local IP address and netmask setting. This is because the protocol
|
||||
includes an ``inquire'' packet which we must be prepared to answer.
|
||||
There are two ways to acomplish this, manually and automatically.
|
||||
There are two ways to accomplish this, manually and automatically.
|
||||
.Pp
|
||||
Whenever such an inquire packet is received, the node sends a
|
||||
.Dv NGM_CISCO_GET_IPADDR
|
||||
@ -155,5 +155,5 @@ and netmask.
|
||||
.Sh LEGAL
|
||||
Cisco is a trademark of Cisco Systems, Inc.
|
||||
.Sh AUTHORS
|
||||
Julian Elisher <julian@whistle.com>,
|
||||
Julian Elischer <julian@whistle.com>,
|
||||
Archie Cobbs <archie@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_hole 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -90,4 +90,4 @@ Instead, it should query the LMI node first.
|
||||
.Xr ng_lmi 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_echo 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -106,7 +106,7 @@ node type; see
|
||||
for a description.
|
||||
.El
|
||||
.Sh SHUTDOWN
|
||||
Because it is currenly not possible to remove a system networking
|
||||
Because it is currently not possible to remove a system networking
|
||||
interface in FreeBSD,
|
||||
.Nm iface
|
||||
nodes are
|
||||
|
@ -124,7 +124,7 @@ control message, or when all hooks have been disconnected.
|
||||
.%T "ANSI T1.617-1991 Annex D"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signalling System No. 1 - Signalling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -97,7 +97,7 @@ hook and expects to receive back the compressed frame on the same hook.
|
||||
Similarly, the
|
||||
.Dv decompress
|
||||
hook is used to uncompress incoming frames when decompression is
|
||||
negotiated (compression and decompression are independenly negotiable).
|
||||
negotiated (compression and decompression are independently negotiable).
|
||||
The type of node attached to these hooks should correspond
|
||||
to the type of compression negotiated, e.g., Deflate, Predictor-1, etc.
|
||||
.Pp
|
||||
@ -170,7 +170,7 @@ the link via the
|
||||
control message.
|
||||
.Pp
|
||||
Each link has configuration parameters for latency (specified in
|
||||
miliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
milliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
The PPP node can be configured for
|
||||
.Em round-robin
|
||||
or
|
||||
@ -189,7 +189,7 @@ when links with different bandwidths exist in the same bundle.
|
||||
When configured for optimal delivery, the PPP node distributes the
|
||||
packet across the links in a way that minimizes the time it takes
|
||||
for the completed packet to be received by the far end. This
|
||||
involves taking into account each link's latency, bandwith, and
|
||||
involves taking into account each link's latency, bandwidth, and
|
||||
current queue length. Therefore these numbers should be
|
||||
configured as accurately as possible. The algorithm does require
|
||||
some computation, so may not be appropriate for very slow machines
|
||||
|
@ -89,7 +89,7 @@ This generic message returns is a human-readable version of the node status.
|
||||
.It Dv NGM_PPPOE_CONNECT
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a client. It must be newly created and
|
||||
a service name can be given as an agument. It is legal to specify a zero length
|
||||
a service name can be given as an argument. It is legal to specify a zero length
|
||||
service name. This is common on some DSL setups. A session request packet
|
||||
will be broadcast on the ethernet.
|
||||
This command uses the
|
||||
@ -97,9 +97,9 @@ This command uses the
|
||||
structure shown below.
|
||||
.It Dv NGM_PPPOE_LISTEN
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a server listenner. The argument
|
||||
the state machine in a manner to become a server listener. The argument
|
||||
given is the name of the service to listen on behalf of. A zero length service
|
||||
length will match all requests for service. A matching ervice request
|
||||
length will match all requests for service. A matching service request
|
||||
packet will be passed unmodified back to the process responsible
|
||||
for starting the service. It can then examine it and pass it on to
|
||||
the session that is started to answer the request.
|
||||
@ -143,14 +143,14 @@ This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
failed Session negotiation. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the failed session.
|
||||
The hook will probably have been removed immediatly after sending this message
|
||||
The hook will probably have been removed immediately after sending this message
|
||||
.It Dv NGM_NGM_PPPOE_CLOSE
|
||||
This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
a request to close a session. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the closed session.
|
||||
The hook will probably have been removed immediatly after sending this
|
||||
message. At present this message is not yet used and a 'failed' mesage
|
||||
The hook will probably have been removed immediately after sending this
|
||||
message. At present this message is not yet used and a 'failed' message
|
||||
will be received at closure instead.
|
||||
.Pp
|
||||
The three commands above use a common data structure.
|
||||
@ -166,7 +166,7 @@ This node shuts down upon receipt of a
|
||||
.Dv NGM_SHUTDOWN
|
||||
control message, when all session have been disconnected or when the
|
||||
.Dv ethernet
|
||||
hook is disconected.
|
||||
hook is disconnected.
|
||||
.Sh EXAMPLE USAGE
|
||||
The following code uses
|
||||
.Dv libnetgraph
|
||||
@ -316,8 +316,8 @@ setup(char *ethername, char *service, char *sessname,
|
||||
sprintf(pppoe_node_name, "[%08x]:", peer->id);
|
||||
} else {
|
||||
/*
|
||||
* There is already someon hogging the data,
|
||||
* return * an error. Some day we'll try
|
||||
* There is already someone hogging the data,
|
||||
* return an error. Some day we'll try
|
||||
* daisy-chaining..
|
||||
*/
|
||||
return (EBUSY);
|
||||
@ -391,4 +391,4 @@ setup(char *ethername, char *service, char *sessname,
|
||||
.%T "RFC 2516 - A Method of transmitting PPP over Ethernet (PPPoE)"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -106,4 +106,4 @@ Not all of RFC 1490 is implemented.
|
||||
.%O RFC 1973
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -124,4 +124,4 @@ data received on that hook can certainly be ignored.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -107,4 +107,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -47,7 +47,7 @@
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm vjc
|
||||
node type performs Van Jacobsen compresion, which is used
|
||||
node type performs Van Jacobsen compression, which is used
|
||||
over PPP, SLIP, and other point-to-point IP connections to
|
||||
compress TCP packet headers. The
|
||||
.Dv ip
|
||||
@ -134,7 +134,7 @@ outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
mesages is immediately sent whenever this occurs.
|
||||
message is immediately sent whenever this occurs.
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
@ -150,7 +150,7 @@ control message.
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
after detecting that a recieved frame has been lost, due to a bad
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
|
@ -52,7 +52,7 @@ Asynchronous framing uses flag bytes and octet-stuffing
|
||||
to simulate a frame oriented connection over an octet-oriented
|
||||
asynchronous line.
|
||||
.Pp
|
||||
The node trasmits and receives asynchronous data on the
|
||||
The node transmits and receives asynchronous data on the
|
||||
.Dv async
|
||||
hook. Incoming data mbuf boundaries are ignored, while
|
||||
outgoing data is sent as a complete frame at a time.
|
||||
|
@ -52,7 +52,7 @@ Asynchronous framing uses flag bytes and octet-stuffing
|
||||
to simulate a frame oriented connection over an octet-oriented
|
||||
asynchronous line.
|
||||
.Pp
|
||||
The node trasmits and receives asynchronous data on the
|
||||
The node transmits and receives asynchronous data on the
|
||||
.Dv async
|
||||
hook. Incoming data mbuf boundaries are ignored, while
|
||||
outgoing data is sent as a complete frame at a time.
|
||||
|
@ -70,7 +70,7 @@ type node.
|
||||
In order to function properly for IP traffic, the node must be informed
|
||||
of the local IP address and netmask setting. This is because the protocol
|
||||
includes an ``inquire'' packet which we must be prepared to answer.
|
||||
There are two ways to acomplish this, manually and automatically.
|
||||
There are two ways to accomplish this, manually and automatically.
|
||||
.Pp
|
||||
Whenever such an inquire packet is received, the node sends a
|
||||
.Dv NGM_CISCO_GET_IPADDR
|
||||
@ -155,5 +155,5 @@ and netmask.
|
||||
.Sh LEGAL
|
||||
Cisco is a trademark of Cisco Systems, Inc.
|
||||
.Sh AUTHORS
|
||||
Julian Elisher <julian@whistle.com>,
|
||||
Julian Elischer <julian@whistle.com>,
|
||||
Archie Cobbs <archie@whistle.com>
|
||||
|
@ -70,7 +70,7 @@ type node.
|
||||
In order to function properly for IP traffic, the node must be informed
|
||||
of the local IP address and netmask setting. This is because the protocol
|
||||
includes an ``inquire'' packet which we must be prepared to answer.
|
||||
There are two ways to acomplish this, manually and automatically.
|
||||
There are two ways to accomplish this, manually and automatically.
|
||||
.Pp
|
||||
Whenever such an inquire packet is received, the node sends a
|
||||
.Dv NGM_CISCO_GET_IPADDR
|
||||
@ -155,5 +155,5 @@ and netmask.
|
||||
.Sh LEGAL
|
||||
Cisco is a trademark of Cisco Systems, Inc.
|
||||
.Sh AUTHORS
|
||||
Julian Elisher <julian@whistle.com>,
|
||||
Julian Elischer <julian@whistle.com>,
|
||||
Archie Cobbs <archie@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_hole 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_hole 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -90,4 +90,4 @@ Instead, it should query the LMI node first.
|
||||
.Xr ng_lmi 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -90,4 +90,4 @@ Instead, it should query the LMI node first.
|
||||
.Xr ng_lmi 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_echo 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -64,4 +64,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr ng_echo 8 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -106,7 +106,7 @@ node type; see
|
||||
for a description.
|
||||
.El
|
||||
.Sh SHUTDOWN
|
||||
Because it is currenly not possible to remove a system networking
|
||||
Because it is currently not possible to remove a system networking
|
||||
interface in FreeBSD,
|
||||
.Nm iface
|
||||
nodes are
|
||||
|
@ -106,7 +106,7 @@ node type; see
|
||||
for a description.
|
||||
.El
|
||||
.Sh SHUTDOWN
|
||||
Because it is currenly not possible to remove a system networking
|
||||
Because it is currently not possible to remove a system networking
|
||||
interface in FreeBSD,
|
||||
.Nm iface
|
||||
nodes are
|
||||
|
@ -124,7 +124,7 @@ control message, or when all hooks have been disconnected.
|
||||
.%T "ANSI T1.617-1991 Annex D"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signalling System No. 1 - Signalling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -124,7 +124,7 @@ control message, or when all hooks have been disconnected.
|
||||
.%T "ANSI T1.617-1991 Annex D"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signalling System No. 1 - Signalling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.%T "ITU-T Q.933 Digital Subscriber Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call Control, Annex A"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -298,7 +298,7 @@ This is the entry point called when a data message is being handed to
|
||||
the node after having been queued in the NETISR system.
|
||||
This allows a node to decide in the
|
||||
.Em Receive data message
|
||||
method that a message should be defered and queued,
|
||||
method that a message should be deferred and queued,
|
||||
and be sure that when it is processed from the queue,
|
||||
it will not be queued again.
|
||||
.It Receive control message
|
||||
@ -347,7 +347,7 @@ A relative address includes only the sequence of hook names, implicitly
|
||||
starting hook traversal at the local node.
|
||||
.Pp
|
||||
There are a couple of special possibilities for the node name.
|
||||
The name ``.'' (refered to as ``.:'') always refers to the local node.
|
||||
The name ``.'' (referred to as ``.:'') always refers to the local node.
|
||||
Also, nodes that have no global name may be addressed by their ID numbers,
|
||||
by enclosing the hex representation of the ID number within square brackets.
|
||||
Here are some examples of valid netgraph addresses:
|
||||
@ -569,7 +569,7 @@ supplied hook names.
|
||||
.It Dv NGM_SHUTDOWN
|
||||
The target node should disconnect from all its neighbours and shut down.
|
||||
Persistent nodes such as those representing physical hardware
|
||||
might not dissappear from the node namespace, but only reset themselves.
|
||||
might not disappear from the node namespace, but only reset themselves.
|
||||
The node must disconnect all of its hooks.
|
||||
This may result in neighbors shutting themselves down, and possibly a
|
||||
cascading shutdown of the entire connected graph.
|
||||
@ -590,7 +590,7 @@ number of hooks attached. The ID is an internal number unique to that node.
|
||||
This returns the information given by
|
||||
.Dv NGM_NODEINFO ,
|
||||
but in addition
|
||||
includes an array of fields describing each link, and the desription for
|
||||
includes an array of fields describing each link, and the description for
|
||||
the node at the far end of that link.
|
||||
.It Dv NGM_LISTNAMES
|
||||
This returns an array of node descriptions (as for
|
||||
@ -619,7 +619,7 @@ Data moving through the
|
||||
system can be accompanied by meta-data that describes some
|
||||
aspect of that data. The form of the meta-data is a fixed header,
|
||||
which contains enough information for most uses, and can optionally
|
||||
be suplemented by trailing
|
||||
be supplemented by trailing
|
||||
.Em option
|
||||
structures, which contain a
|
||||
.Em cookie
|
||||
@ -747,7 +747,7 @@ for each DLCI.
|
||||
.It FRAME RELAY LMI
|
||||
Automatically handles frame relay
|
||||
``LMI'' (link management interface) operations and packets.
|
||||
Automatically probes and detects whch of several LMI standards
|
||||
Automatically probes and detects which of several LMI standards
|
||||
is in use at the exchange.
|
||||
.Pp
|
||||
.It TTY
|
||||
@ -770,7 +770,7 @@ The interfaces are named
|
||||
etc.
|
||||
.El
|
||||
.Sh NOTES
|
||||
Whether a named node exists can be checked by trying to send a control mesage
|
||||
Whether a named node exists can be checked by trying to send a control message
|
||||
to it (e.g.,
|
||||
.Dv NGM_NODEINFO
|
||||
).
|
||||
@ -786,7 +786,7 @@ There are three exceptions:
|
||||
.It 1
|
||||
Mbufs sent across a data link are never to be freed by the sender.
|
||||
.It 2
|
||||
Any meta-data information travelling with the data has the same restriction.
|
||||
Any meta-data information traveling with the data has the same restriction.
|
||||
It might be freed by any node the data passes through, and a
|
||||
.Dv NULL
|
||||
passed onwards, but the caller will never free it.
|
||||
@ -806,7 +806,7 @@ recipient should copy them if it wants to keep that information.
|
||||
.Sh FILES
|
||||
.Bl -tag -width xxxxx -compact
|
||||
.It Pa /sys/netgraph/netgraph.h
|
||||
Definitions for use soley within the kernel by
|
||||
Definitions for use solely within the kernel by
|
||||
.Nm
|
||||
nodes.
|
||||
.It Pa /sys/netgraph/ng_message.h
|
||||
|
@ -97,7 +97,7 @@ hook and expects to receive back the compressed frame on the same hook.
|
||||
Similarly, the
|
||||
.Dv decompress
|
||||
hook is used to uncompress incoming frames when decompression is
|
||||
negotiated (compression and decompression are independenly negotiable).
|
||||
negotiated (compression and decompression are independently negotiable).
|
||||
The type of node attached to these hooks should correspond
|
||||
to the type of compression negotiated, e.g., Deflate, Predictor-1, etc.
|
||||
.Pp
|
||||
@ -170,7 +170,7 @@ the link via the
|
||||
control message.
|
||||
.Pp
|
||||
Each link has configuration parameters for latency (specified in
|
||||
miliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
milliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
The PPP node can be configured for
|
||||
.Em round-robin
|
||||
or
|
||||
@ -189,7 +189,7 @@ when links with different bandwidths exist in the same bundle.
|
||||
When configured for optimal delivery, the PPP node distributes the
|
||||
packet across the links in a way that minimizes the time it takes
|
||||
for the completed packet to be received by the far end. This
|
||||
involves taking into account each link's latency, bandwith, and
|
||||
involves taking into account each link's latency, bandwidth, and
|
||||
current queue length. Therefore these numbers should be
|
||||
configured as accurately as possible. The algorithm does require
|
||||
some computation, so may not be appropriate for very slow machines
|
||||
|
@ -97,7 +97,7 @@ hook and expects to receive back the compressed frame on the same hook.
|
||||
Similarly, the
|
||||
.Dv decompress
|
||||
hook is used to uncompress incoming frames when decompression is
|
||||
negotiated (compression and decompression are independenly negotiable).
|
||||
negotiated (compression and decompression are independently negotiable).
|
||||
The type of node attached to these hooks should correspond
|
||||
to the type of compression negotiated, e.g., Deflate, Predictor-1, etc.
|
||||
.Pp
|
||||
@ -170,7 +170,7 @@ the link via the
|
||||
control message.
|
||||
.Pp
|
||||
Each link has configuration parameters for latency (specified in
|
||||
miliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
milliseconds) and bandwidth (specified in tens of bytes per second).
|
||||
The PPP node can be configured for
|
||||
.Em round-robin
|
||||
or
|
||||
@ -189,7 +189,7 @@ when links with different bandwidths exist in the same bundle.
|
||||
When configured for optimal delivery, the PPP node distributes the
|
||||
packet across the links in a way that minimizes the time it takes
|
||||
for the completed packet to be received by the far end. This
|
||||
involves taking into account each link's latency, bandwith, and
|
||||
involves taking into account each link's latency, bandwidth, and
|
||||
current queue length. Therefore these numbers should be
|
||||
configured as accurately as possible. The algorithm does require
|
||||
some computation, so may not be appropriate for very slow machines
|
||||
|
@ -89,7 +89,7 @@ This generic message returns is a human-readable version of the node status.
|
||||
.It Dv NGM_PPPOE_CONNECT
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a client. It must be newly created and
|
||||
a service name can be given as an agument. It is legal to specify a zero length
|
||||
a service name can be given as an argument. It is legal to specify a zero length
|
||||
service name. This is common on some DSL setups. A session request packet
|
||||
will be broadcast on the ethernet.
|
||||
This command uses the
|
||||
@ -97,9 +97,9 @@ This command uses the
|
||||
structure shown below.
|
||||
.It Dv NGM_PPPOE_LISTEN
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a server listenner. The argument
|
||||
the state machine in a manner to become a server listener. The argument
|
||||
given is the name of the service to listen on behalf of. A zero length service
|
||||
length will match all requests for service. A matching ervice request
|
||||
length will match all requests for service. A matching service request
|
||||
packet will be passed unmodified back to the process responsible
|
||||
for starting the service. It can then examine it and pass it on to
|
||||
the session that is started to answer the request.
|
||||
@ -143,14 +143,14 @@ This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
failed Session negotiation. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the failed session.
|
||||
The hook will probably have been removed immediatly after sending this message
|
||||
The hook will probably have been removed immediately after sending this message
|
||||
.It Dv NGM_NGM_PPPOE_CLOSE
|
||||
This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
a request to close a session. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the closed session.
|
||||
The hook will probably have been removed immediatly after sending this
|
||||
message. At present this message is not yet used and a 'failed' mesage
|
||||
The hook will probably have been removed immediately after sending this
|
||||
message. At present this message is not yet used and a 'failed' message
|
||||
will be received at closure instead.
|
||||
.Pp
|
||||
The three commands above use a common data structure.
|
||||
@ -166,7 +166,7 @@ This node shuts down upon receipt of a
|
||||
.Dv NGM_SHUTDOWN
|
||||
control message, when all session have been disconnected or when the
|
||||
.Dv ethernet
|
||||
hook is disconected.
|
||||
hook is disconnected.
|
||||
.Sh EXAMPLE USAGE
|
||||
The following code uses
|
||||
.Dv libnetgraph
|
||||
@ -316,8 +316,8 @@ setup(char *ethername, char *service, char *sessname,
|
||||
sprintf(pppoe_node_name, "[%08x]:", peer->id);
|
||||
} else {
|
||||
/*
|
||||
* There is already someon hogging the data,
|
||||
* return * an error. Some day we'll try
|
||||
* There is already someone hogging the data,
|
||||
* return an error. Some day we'll try
|
||||
* daisy-chaining..
|
||||
*/
|
||||
return (EBUSY);
|
||||
@ -391,4 +391,4 @@ setup(char *ethername, char *service, char *sessname,
|
||||
.%T "RFC 2516 - A Method of transmitting PPP over Ethernet (PPPoE)"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -89,7 +89,7 @@ This generic message returns is a human-readable version of the node status.
|
||||
.It Dv NGM_PPPOE_CONNECT
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a client. It must be newly created and
|
||||
a service name can be given as an agument. It is legal to specify a zero length
|
||||
a service name can be given as an argument. It is legal to specify a zero length
|
||||
service name. This is common on some DSL setups. A session request packet
|
||||
will be broadcast on the ethernet.
|
||||
This command uses the
|
||||
@ -97,9 +97,9 @@ This command uses the
|
||||
structure shown below.
|
||||
.It Dv NGM_PPPOE_LISTEN
|
||||
Tell a nominated newly created hook that it's session should enter
|
||||
the state machine in a manner to become a server listenner. The argument
|
||||
the state machine in a manner to become a server listener. The argument
|
||||
given is the name of the service to listen on behalf of. A zero length service
|
||||
length will match all requests for service. A matching ervice request
|
||||
length will match all requests for service. A matching service request
|
||||
packet will be passed unmodified back to the process responsible
|
||||
for starting the service. It can then examine it and pass it on to
|
||||
the session that is started to answer the request.
|
||||
@ -143,14 +143,14 @@ This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
failed Session negotiation. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the failed session.
|
||||
The hook will probably have been removed immediatly after sending this message
|
||||
The hook will probably have been removed immediately after sending this message
|
||||
.It Dv NGM_NGM_PPPOE_CLOSE
|
||||
This command is sent to the node that started this session with one of the
|
||||
above messages, and reports a state change. This message reports
|
||||
a request to close a session. It uses the structure shown below, and
|
||||
reports back the hook name corresponding to the closed session.
|
||||
The hook will probably have been removed immediatly after sending this
|
||||
message. At present this message is not yet used and a 'failed' mesage
|
||||
The hook will probably have been removed immediately after sending this
|
||||
message. At present this message is not yet used and a 'failed' message
|
||||
will be received at closure instead.
|
||||
.Pp
|
||||
The three commands above use a common data structure.
|
||||
@ -166,7 +166,7 @@ This node shuts down upon receipt of a
|
||||
.Dv NGM_SHUTDOWN
|
||||
control message, when all session have been disconnected or when the
|
||||
.Dv ethernet
|
||||
hook is disconected.
|
||||
hook is disconnected.
|
||||
.Sh EXAMPLE USAGE
|
||||
The following code uses
|
||||
.Dv libnetgraph
|
||||
@ -316,8 +316,8 @@ setup(char *ethername, char *service, char *sessname,
|
||||
sprintf(pppoe_node_name, "[%08x]:", peer->id);
|
||||
} else {
|
||||
/*
|
||||
* There is already someon hogging the data,
|
||||
* return * an error. Some day we'll try
|
||||
* There is already someone hogging the data,
|
||||
* return an error. Some day we'll try
|
||||
* daisy-chaining..
|
||||
*/
|
||||
return (EBUSY);
|
||||
@ -391,4 +391,4 @@ setup(char *ethername, char *service, char *sessname,
|
||||
.%T "RFC 2516 - A Method of transmitting PPP over Ethernet (PPPoE)"
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -106,4 +106,4 @@ Not all of RFC 1490 is implemented.
|
||||
.%O RFC 1973
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -106,4 +106,4 @@ Not all of RFC 1490 is implemented.
|
||||
.%O RFC 1973
|
||||
.Re
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -124,4 +124,4 @@ data received on that hook can certainly be ignored.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -124,4 +124,4 @@ data received on that hook can certainly be ignored.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -107,4 +107,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -107,4 +107,4 @@ control message, or when all hooks have been disconnected.
|
||||
.Xr netgraph 4 ,
|
||||
.Xr ngctl 8 .
|
||||
.Sh AUTHOR
|
||||
Julian Elisher <julian@whistle.com>
|
||||
Julian Elischer <julian@whistle.com>
|
||||
|
@ -47,7 +47,7 @@
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm vjc
|
||||
node type performs Van Jacobsen compresion, which is used
|
||||
node type performs Van Jacobsen compression, which is used
|
||||
over PPP, SLIP, and other point-to-point IP connections to
|
||||
compress TCP packet headers. The
|
||||
.Dv ip
|
||||
@ -134,7 +134,7 @@ outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
mesages is immediately sent whenever this occurs.
|
||||
message is immediately sent whenever this occurs.
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
@ -150,7 +150,7 @@ control message.
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
after detecting that a recieved frame has been lost, due to a bad
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
|
@ -47,7 +47,7 @@
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm vjc
|
||||
node type performs Van Jacobsen compresion, which is used
|
||||
node type performs Van Jacobsen compression, which is used
|
||||
over PPP, SLIP, and other point-to-point IP connections to
|
||||
compress TCP packet headers. The
|
||||
.Dv ip
|
||||
@ -134,7 +134,7 @@ outgoing compressed TCP packets. This value should be zero unless
|
||||
either (a) it not possible for an incoming frame to be lost, or
|
||||
(b) lost frames can be reliably detected and a
|
||||
.Dv NGM_VJC_RECV_ERROR
|
||||
mesages is immediately sent whenever this occurs.
|
||||
message is immediately sent whenever this occurs.
|
||||
.It Dv NGM_VJC_GET_STATE
|
||||
This command returns the node's current state described by the
|
||||
.Dv "struct slcompress"
|
||||
@ -150,7 +150,7 @@ control message.
|
||||
When the
|
||||
.Dv compressCID
|
||||
is set to one, this message must be sent to the node immediately
|
||||
after detecting that a recieved frame has been lost, due to a bad
|
||||
after detecting that a received frame has been lost, due to a bad
|
||||
checksum or for any other reason. Failing to do this can result
|
||||
in corrupted TCP stream data.
|
||||
.Sh SHUTDOWN
|
||||
|
Loading…
Reference in New Issue
Block a user