.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "BPDRIVER 1"
.TH BPDRIVER 1 "2016-07-07" "perl v5.24.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"
bpdriver \- Bundle Protocol transmission test program
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBbpdriver\fR \fInbrOfCycles\fR \fIownEndpointId\fR \fIdestinationEndpointId\fR [\fIlength\fR] [t\fI\s-1TTL\s0\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBbpdriver\fR uses Bundle Protocol to send \fInbrOfCycles\fR application data
units of length indicated by \fIlength\fR, to a counterpart application task
that has opened the \s-1BP\s0 endpoint identified by \fIdestinationEndpointId\fR.
.PP
If omitted, \fIlength\fR defaults to 60000.
.PP
\&\fI\s-1TTL\s0\fR indicates the number of seconds the bundles may remain in the
network, undelivered, before they are automatically destroyed. If omitted, \fI\s-1TTL\s0\fR
defaults to 300 seconds.
.PP
\&\fBbpdriver\fR normally runs in \*(L"echo\*(R" mode: after sending each bundle it
waits for an acknowledgment bundle before sending the next one.  For this
purpose, the counterpart application task should be \fBbpecho\fR.
.PP
Alternatively \fBbpdriver\fR can run in \*(L"streaming\*(R" mode, i.e., without
expecting or receiving acknowledgments.  Streaming mode is enabled when
\&\fIlength\fR is specified as a negative number, in which case the additive
inverse of \fIlength\fR is used as the effective value of \fIlength\fR.  For
this purpose, the counterpart application task should be \fBbpcounter\fR.
.PP
If the effective value of \fIlength\fR is 1, the sizes of the transmitted
service data units will be randomly selected multiples of 1024 in the
range 1024 to 62464.
.PP
\&\fBbpdriver\fR normally runs with custody transfer disabled.  To request
custody transfer for all bundles sent by \fBbpdriver\fR, specify \fInbrOfCycles\fR
as a negative number; the additive inverse of \fInbrOfCycles\fR will be used
as its effective value in this case.
.PP
When all copies of the file have been sent, \fBbpdriver\fR prints a performance
report.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
.ie n .IP """0""" 4
.el .IP "``0''" 4
.IX Item "0"
\&\fBbpdriver\fR has terminated.  Any problems encountered during operation
will be noted in the \fBion.log\fR log file.
.SH "FILES"
.IX Header "FILES"
The service data units transmitted by \fBbpdriver\fR are sequences of text
obtained from a file in the current working directory named \*(L"bpdriverAduFile\*(R",
which \fBbpdriver\fR creates automatically.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
No environment variables apply.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Diagnostic messages produced by \fBbpdriver\fR are written to the \s-1ION\s0 log
file \fIion.log\fR.
.IP "Can't attach to \s-1BP.\s0" 4
.IX Item "Can't attach to BP."
\&\fBbpadmin\fR has not yet initialized Bundle Protocol operations.
.IP "Can't open own endpoint." 4
.IX Item "Can't open own endpoint."
Another application has already opened \fIownEndpointId\fR.  Terminate that
application and rerun.
.IP "Can't create \s-1ADU\s0 file" 4
.IX Item "Can't create ADU file"
Operating system error.  Check errtext, correct problem, and rerun.
.IP "Error writing to \s-1ADU\s0 file" 4
.IX Item "Error writing to ADU file"
Operating system error.  Check errtext, correct problem, and rerun.
.IP "bpdriver can't create file ref." 4
.IX Item "bpdriver can't create file ref."
\&\s-1ION\s0 system error.  Check for earlier diagnostic messages describing
the cause of the error; correct problem and rerun.
.IP "bpdriver can't create \s-1ZCO.\s0" 4
.IX Item "bpdriver can't create ZCO."
\&\s-1ION\s0 system error.  Check for earlier diagnostic messages describing
the cause of the error; correct problem and rerun.
.IP "bpdriver can't send message" 4
.IX Item "bpdriver can't send message"
Bundle Protocol service to the remote endpoint has been stopped.
.IP "bpdriver reception failed" 4
.IX Item "bpdriver reception failed"
\&\fBbpdriver\fR is in \*(L"echo\*(R" mode, and Bundle Protocol delivery service
has been stopped.
.SH "BUGS"
.IX Header "BUGS"
Report bugs to <ion\-bugs@korgano.eecs.ohiou.edu>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIbpadmin\fR\|(1), \fIbpcounter\fR\|(1), \fIbpecho\fR\|(1), \fIbp\fR\|(3)