dl_disconnect_ind.7.man

This a separate release of the OpenSS7 X/Open XTI/TLI library, TLI modules (timod, tirdwr) and the I

'\" rtp
.\" -*- nroff -*- vim: ft=nroff noautoindent nocindent nosmartindent
.\"
.\" @(#) DL_DISCONNECT_IND.7.man,v 0.9.2.3 2004/05/16 02:35:43 brian Exp
.\"
.\" =========================================================================
.\"
.\" Copyright (C) 2001-2004  OpenSS7 Corporation <www.openss7.com>
.\"
.\" All Rights Reserved.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" -------------------------------------------------------------------------
.\"
.\" U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software
.\" on behalf of the U.S. Government ("Government"), the following
.\" provisions apply to you.  If the Software is supplied by the Department
.\" of Defense ("DoD"), it is classified as "Commercial Computer Software"
.\" under paragraph 252.227-7014 of the DoD Supplement to the Federal
.\" Acquisition Regulations ("DFARS") (or any successor regulations) and the
.\" Government is acquiring only the license rights granted herein (the
.\" license rights customarily provided to non-Government users).  If the
.\" Software is supplied to any unit or agency of the Government other than
.\" DoD, it is classified as "Restricted Computer Software" and the
.\" Government's rights in the Software are defined in paragraph 52.227-19
.\" of the Federal Acquisition Regulations ("FAR") (or any success
.\" regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the
.\" NASA Supplement to the FAR (or any successor regulations).
.\"
.\" =========================================================================
.\" 
.\" Commercial licensing and support of this software is available from
.\" OpenSS7 Corporation at a fee.  See http://www.openss7.com/
.\" 
.\" =========================================================================
.\"
.\" Last Modified 2004/05/16 02:35:43 by brian
.\"
.\" =========================================================================
.so strxnet.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database strxnet.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.TH DL_DISCONNECT_IND 7 "2004/05/16 02:35:43" "strxnet-0_9_2-4" "Data Link Provider Interface (DLPI)"
.SH NAME
.B DL_DISCONNECT_IND (dl_disconnect_ind_t)
\- informs the DLS user that the data link connection on this stream has
been disconnected, or that apending connection (either
.BR DL_CONNECT_REQ (7)
or
.BR DL_CONNECT_IND (7))
has been aborted.  The primitive indicates the origin and the cause of the
disconnect.
.SH SYNOPSIS
The message consists of one
.B M_PROTO
message block containing the structure shown below.
.sp
.nf
\fC\s-1\
typedef struct {
    t_uscalar_t  dl_primitive;
    t_uscalar_t  dl_originator;
    t_uscalar_t  dl_reason;
    t_uscalar_t  dl_correlation;
} dl_disconnect_ind_t;
\fR\s+1
.fi
.SH PARAMETERS
.TP
.I dl_primitive
conveys
.BR DL_DISCONNECT_IND .
.TP
.I dl_originator
conveys whether the disconnect was DLS user or DLS provider originated
.RB ( DL_USER
or
.BR DL_PROVIDER ,
respectively).
.TP
.I dl_reason
conveys the reason for the disconnect:
.RS
.TP
.B DL_DISC_PERMANENT_CONDITION
connection released due to permanent condition
.TP
.B DL_DISC_TRANSIENT_CONDITION
connection released due to transient condition
.TP
.B DL_CONREJ_DEST_UNKNOWN
unknown destination for connect request
.TP
.B DL_CONREJ_DEST_UNREACH_PERMANENT
could not reach destination for connect request - permanent condition
.TP
.B DL_CONREJ_DEST_UNREACH_TRANSIENT
could not reach destination for connect request - transient condition
.TP
.B DL_CONREJ_QOS_UNAVAIL_PERMANENT
requested quality of service parameters permanently unavailable during
connection establishment
.TP
.B DL_CONREJ_QOS_UNAVAIL_TRANSIENT
requested quality of service parameters temporarily unavailable during
connection establishment
.TP
.B DL_DISC_UNSPECIFIED
reason unspecified
.RE
.TP
.I dl_correlation
if non-zero, conveys the correlation number that was contained in the
.BR DL_CONNECT_IND (7)
that is being aborted (see
.I \*(lqMulti-threaded Connection Establishment,\*(rq
.BR dlpi (7)).
This value permits the DLS user to associate the message with the proper
.BR DL_CONNECT_IND (7).
If the disconnect indication is indicating the release of a connection that is
already established, or is indicating the rejection of a previously sent
.BR DL_CONNECT_REQ (7),
the value of
.I dl_correlation
will be zero.
.SH STATE
The message is valid in any of the states:
.BR DL_DATAXFER ,
.BR DL_INCON_PENDING ,
.BR DL_OUTCON_PENDING ,
.BR DL_PROV_RESET_PENDING ,
.BR DL_USER_RESET_PENDING .
.SH "NEW STATE"
The resulting state is
.BR DL_IDLE .
.SH HISTORY
.PP
The Data Link Provider Interface first appeared in SVR 4.
.[
svr4
.]
.SH CONFORMANCE
.PP
This interface conforms to DLPI Revision 2.
.[
dlpi
.]
.XX
.[
magic
.]
.[
advprog
.]
.[
$LIST$
.]
.T2