SSCOP(1) BSD General Commands Manual SSCOP(1)NAME
sscop -- SSCOP transport protocol
SYNOPSIS
sscop [-Fbefhirwx3] [-V X] [-W N] [-a p=v] [-l N] [-t t=m] [-v X]
DESCRIPTION
The sscop tool implements the Q.2110 transport protocol. Normally the program reads from standard input and sends this input over the SSCOP
protocol on the standard output file descriptor. This means, that the standard output file descriptor should be connected in read-write mode.
The program takes the following arguments:
-F Use frameing on the SSCOP connection (see the -f option).
-V X Set the verbose flag to the hex value X.
-W N Set the initial SSCOP window to N.
-a p=v Set SSCOP parameter p to the value v. The following parameters may be set:
j=N Set the maximum SSCOP-UU data size to N octets.
k=N Set the maximum SSCOP SDU data size to N octets.
cc=N Set the parameter MaxCC (maximum number of connection control message re-transmissions) to the value N.
pd=N Set the parameter MaxPD (maximum acceptable number of outstanding unacknowledged SD PDUs before sending a POLL) to the value
N.
stat=N Set the parameter MaxSTAT (maximum number of elements placed in a STAT PDU) to the value N.
-b Enable the ATM-Forum SSCOP robustness enhancement.
-e Exit when there is an end of file condition on the input file or the SSCOP indicates a release confirmation.
-f Use the framing protocol for communication over the SSCOP link. See frame(l) (libbegemot) for framing.
-h Print a short help information and exit.
-i Try not to read from the user input file descriptor. Assume that we a receiving only.
-l N Loose every Nth message. This is used for testing.
-r Revert user and SSCOP file descriptors. That means, that user input and output is done on standard output and SSCOP input and output
on standard input.
-t t=m Set SSCOP timer t to m milliseconds. The following timers may be set:
cc=m Set the connection control timer to m. This timer controls the retransmission of connection control messages.
poll=m Set the poll timer to m. This timer controls the transmission of POLL messages.
ka=m Set the keep-alive timer to m. This timer controls the maximum length of the transient phase.
nr=m Set the no-response timer to m. This timer controls the maximum time between two received STAT PDUs before the connection is
aborted.
idle=m Set the idle timer to m. This timer controls the length of the idle phase.
-v X Set the SSCOP library verbose flag to the hex value.
-w Don't start the SSCOP protocol. Wait for a establish indication from the remote side.
-x Enable to POLL after retransmission flag.
-3 Send user output to file descriptor 3.
EXAMPLES
The following command line sends the file Makefile over a pipe (this depends on the feature that pipes are bi-directional):
cat Makefile | sscop -reF | sscop -weF
SEE ALSO libunimsg(3)STANDARDS
The implemented protocol conforms to ITU-T recommendation Q.2110.
AUTHORS
Hartmut Brandt <harti@FreeBSD.org>
BSD October 28, 2003 BSD
Check Out this Related Man Page
NG_SSCFU(4) BSD Kernel Interfaces Manual NG_SSCFU(4)NAME
ng_sscfu -- netgraph SSCF at the UNI node type
SYNOPSIS
#include <netnatm/saal/sscopdef.h>
#include <netnatm/saal/sscfudef.h>
#include <netgraph/atm/ng_sscfu.h>
DESCRIPTION
The sscfu netgraph node type implements ITU-T recommendation Q.2130. This recommendation specifies the Service Specific Coordination Func-
tion at the UNI. This is a thin sub-layer between the SSCOP (see ng_sscop(4)) and the UNI signalling. This node does not really implement a
protocol but provides a mapping between the signals at the upper layer of the SSCOP and the signals the UNI expects at its lower layer. It
also provides default values for the parameters of the SSCOP.
After creation of the node, the SSCF instance must be created by sending an ``enable'' message to the node. If the node is enabled, default
SSCOP parameters can be retrieved and set in the corresponding SSCOP instance.
The node is shut down either by a NGM_SHUTDOWN message, or when all hooks are disconnected.
HOOKS
Each sscfu node has two hooks with fixed names:
lower This hook is the interface to the SSCOP. The interface expected here is exactly that which is exported by the ng_sscop(4) node type.
upper This is the interface to the UNI. It uses the following message format:
struct sscfu_arg {
uint32_t sig;
u_char data[];
};
The sig field is one of the following signals:
enum saal_sig {
SAAL_ESTABLISH_request, /* U -> SAAL: (UU) */
SAAL_ESTABLISH_indication, /* SAAL -> U: (UU) */
SAAL_ESTABLISH_confirm, /* SAAL -> U: (UU) */
SAAL_RELEASE_request, /* U -> SAAL: (UU) */
SAAL_RELEASE_confirm, /* SAAL -> U: */
SAAL_RELEASE_indication, /* SAAL -> U: (UU) */
SAAL_DATA_request, /* U -> SAAL: (DATA) */
SAAL_DATA_indication, /* SAAL -> U: (DATA) */
SAAL_UDATA_request, /* U -> SAAL: (UDATA) */
SAAL_UDATA_indication, /* SAAL -> U: (UDATA) */
};
The arrows in the comment show the direction of the signal, whether it is a signal that comes out of the node ('->'), or is sent by
the node user to the node ('<-'). The type of the data expected for the signal is specified in parentheses. This data starts at the
data field of the message structure.
If the lower hook is disconnected and the node is enabled, the protocol state is reset.
CONTROL MESSAGES
The sscfu node understands the generic messages plus the following:
NGM_SSCFU_GETDEFPARAM
This message returns a sscop_param structure, which contains the default parameters for the SSCOP at the UNI. This structure should
be used for a NGM_SSCOP_SETPARAM message to the SSCOP node below the SSCF.
NGM_SSCFU_ENABLE
This message creates the actual SSCF instance and initializes it. Until this is done, parameters may neither be retrieved nor set,
and all messages received on any hook are discarded.
NGM_SSCFU_DISABLE
Destroy the SSCF instance. After this, all messages on any hooks are discarded.
NGM_SSCFU_GETDEBUG
Retrieve the debugging flags in a uint32_t.
NGM_SSCFU_SETDEBUG
Set debugging flags. The argument must be a uint32_t.
NGM_SSCFU_GETSTATE
Retrieve the current state of the SSCFU instance in a uint32_t. If the node has not been enabled, 0 is returned.
SEE ALSO netgraph(4), ng_atm(4), ng_sscop(4), ngctl(8)AUTHORS
Harti Brandt <harti@FreeBSD.org>
BSD October 24, 2003 BSD