.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "UDPCLO 1"
.TH UDPCLO 1 "2014-07-08" "perl v5.20.1" "BP executables"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
udpclo \- UDP\-based BP convergence layer output task
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBudpclo\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBudpclo\fR is a background \*(L"daemon\*(R" task that extracts bundles from the
queues of bundles ready for transmission via \s-1UDP\s0 to remote bundle protocol
agents, encapsulates them in \s-1UDP\s0 datagrams, and sends those datagrams to
the appropriate remote \s-1UDP\s0 sockets as indicated by the host names and
\&\s-1UDP\s0 port numbers (destination induct names) associated with the bundles
by the routing daemons that enqueued them.
.PP
Note that \fBudpclo\fR is a \*(L"promiscuous\*(R" \s-1CLO\s0 daemon, able to transmit bundles
to any \s-1UDP\s0 destination induct.  Its duct name is '*' rather than
the induct name of any single \s-1UDP\s0 destination induct to which it might be
dedicated, so scheme configuration directives that cite this outduct must
provide destination induct IDs.  For the \s-1UDP\s0 convergence-layer protocol,
destination induct IDs are identical to induct names, i.e., they are of
the form \fIlocal_hostname\fR[:\fIlocal_port_nbr\fR].
.PP
\&\fBudpclo\fR is spawned automatically by \fBbpadmin\fR in response to the 's' (\s-1START\s0)
command that starts operation of the Bundle Protocol, and it is terminated by
\&\fBbpadmin\fR in response to an 'x' (\s-1STOP\s0) command.  \fBudpclo\fR can also be
spawned and terminated in response to \s-1START\s0 and \s-1STOP\s0 commands that pertain
specifically to the \s-1UDP\s0 convergence layer protocol.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.ie n .IP """0""" 4
.el .IP "``0''" 4
.IX Item "0"
\&\fBudpclo\fR terminated normally, for reasons noted in the \fBion.log\fR file.  If
this termination was not commanded, investigate and solve the problem identified
in the log file and use \fBbpadmin\fR to restart \fBudpclo\fR.
.ie n .IP """1""" 4
.el .IP "``1''" 4
.IX Item "1"
\&\fBudpclo\fR terminated abnormally, for reasons noted in the \fBion.log\fR file.
Investigate and solve the problem identified in the log file, then use
\&\fBbpadmin\fR to restart \fBudpclo\fR.
.SH "FILES"
.IX Header "FILES"
No configuration files are needed.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
No environment variables apply.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
The following diagnostics may be issued to the \fBion.log\fR log file:
.IP "udpclo can't attach to \s-1BP.\s0" 4
.IX Item "udpclo can't attach to BP."
\&\fBbpadmin\fR has not yet initialized Bundle Protocol operations.
.IP "No memory for \s-1UDP\s0 buffer in udpclo." 4
.IX Item "No memory for UDP buffer in udpclo."
\&\s-1ION\s0 system error.  Check errtext, correct problem, and restart \s-1UDP.\s0
.IP "No such udp duct." 4
.IX Item "No such udp duct."
No \s-1UDP\s0 outduct with duct name '*' has been added to the \s-1BP\s0 database.  Use
\&\fBbpadmin\fR to stop the \s-1UDP\s0 convergence-layer protocol, add the outduct, and
then restart the \s-1UDP\s0 protocol.
.IP "\s-1CLO\s0 task is already started for this engine." 4
.IX Item "CLO task is already started for this engine."
Redundant initiation of \fBudpclo\fR.
.IP "\s-1CLO\s0 can't open \s-1UDP\s0 socket" 4
.IX Item "CLO can't open UDP socket"
Operating system error.  Check errtext, correct problem, and restart \fBudpclo\fR.
.IP "\s-1CLO\s0 \fIwrite()\fR error on socket" 4
.IX Item "CLO write() error on socket"
Operating system error.  Check errtext, correct problem, and restart \fBudpclo\fR.
.IP "Bundle is too big for \s-1UDP CLA.\s0" 4
.IX Item "Bundle is too big for UDP CLA."
Configuration error: bundles that are too large for \s-1UDP\s0 transmission (i.e.,
larger than 65535 bytes) are being enqueued for \fBudpclo\fR.  Change routing.
.SH "BUGS"
.IX Header "BUGS"
Report bugs to <ion\-bugs@korgano.eecs.ohiou.edu>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIbpadmin\fR\|(1), \fIbprc\fR\|(5), \fIudpcli\fR\|(1)