← Back to branch summary

~ubuntu-branches/debian/experimental/ion/experimental

« back to all changes in this revision

Viewing changes to bp/doc/pod1/bpdriver.pod

  • Committer: Package Import Robot
  • Author(s): Leo Iannacone
  • Date: 2012-02-01 09:46:31 UTC
  • Revision ID: package-import@ubuntu.com-20120201094631-qpfwehc1b7ftkjgx
Tags: upstream-2.5.3~dfsg1
Import upstream version 2.5.3~dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
bp/doc/pod1/bpdriver.pod
 
1
=head1 NAME
 
2
 
 
3
bpdriver - Bundle Protocol transmission test program
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
B<bpdriver> I<nbrOfCycles> I<ownEndpointId> I<destinationEndpointId> [I<length>] [tI<TTL>]
 
8
 
 
9
=head1 DESCRIPTION
 
10
 
 
11
B<bpdriver> uses Bundle Protocol to send I<nbrOfCycles> application data
 
12
units of length indicated by I<length>, to a counterpart application task
 
13
that has opened the BP endpoint identified by I<destinationEndpointId>.
 
14
 
 
15
If omitted, I<length> defaults to 60000.  
 
16
 
 
17
I<TTL> indicates the number of seconds the bundles may remain in the
 
18
network, undelivered, before they are automatically destroyed. If omitted, I<TTL>
 
19
defaults to 300 seconds.
 
20
 
 
21
B<bpdriver> normally runs in "echo" mode: after sending each bundle it
 
22
waits for an acknowledgment bundle before sending the next one.  For this
 
23
purpose, the counterpart application task should be B<bpecho>.
 
24
 
 
25
Alternatively B<bpdriver> can run in "streaming" mode, i.e., without
 
26
expecting or receiving acknowledgments.  Streaming mode is enabled when
 
27
I<length> is specified as a negative number, in which case the additive
 
28
inverse of I<length> is used as the effective value of I<length>.  For
 
29
this purpose, the counterpart application task should be B<bpcounter>.
 
30
 
 
31
If the effective value of I<length> is 1, the sizes of the transmitted
 
32
service data units will be randomly selected multiples of 1024 in the
 
33
range 1024 to 62464.
 
34
 
 
35
B<bpdriver> normally runs with custody transfer disabled.  To request
 
36
custody transfer for all bundles sent by B<bpdriver>, specify I<nbrOfCycles>
 
37
as a negative number; the additive inverse of I<nbrOfCycles> will be used
 
38
as its effective value in this case.
 
39
 
 
40
When all copies of the file have been sent, B<bpdriver> prints a performance
 
41
report.
 
42
 
 
43
=head1 EXIT STATUS
 
44
 
 
45
=over 4
 
46
 
 
47
=item 0
 
48
 
 
49
B<bpdriver> has terminated.  Any problems encountered during operation
 
50
will be noted in the B<ion.log> log file.
 
51
 
 
52
=back
 
53
 
 
54
=head1 FILES
 
55
 
 
56
The service data units transmitted by B<bpdriver> are sequences of text
 
57
obtained from a file in the current working directory named "bpdriverAduFile",
 
58
which B<bpdriver> creates automatically.
 
59
 
 
60
=head1 ENVIRONMENT
 
61
 
 
62
No environment variables apply.
 
63
 
 
64
=head1 DIAGNOSTICS
 
65
 
 
66
Diagnostic messages produced by B<bpdriver> are written to the ION log
 
67
file I<ion.log>.
 
68
 
 
69
=over 4
 
70
 
 
71
=item Can't attach to BP.
 
72
 
 
73
B<bpadmin> has not yet initialized Bundle Protocol operations.
 
74
 
 
75
=item Can't open own endpoint.
 
76
 
 
77
Another application has already opened I<ownEndpointId>.  Terminate that
 
78
application and rerun.
 
79
 
 
80
=item Can't create ADU file
 
81
 
 
82
Operating system error.  Check errtext, correct problem, and rerun.
 
83
 
 
84
=item Error writing to ADU file
 
85
 
 
86
Operating system error.  Check errtext, correct problem, and rerun.
 
87
 
 
88
=item bpdriver can't create file ref.
 
89
 
 
90
ION system error.  Check for earlier diagnostic messages describing
 
91
the cause of the error; correct problem and rerun.
 
92
 
 
93
=item bpdriver can't create ZCO.
 
94
 
 
95
ION system error.  Check for earlier diagnostic messages describing
 
96
the cause of the error; correct problem and rerun.
 
97
 
 
98
=item bpdriver can't send message
 
99
 
 
100
Bundle Protocol service to the remote endpoint has been stopped.
 
101
 
 
102
=item bpdriver reception failed
 
103
 
 
104
B<bpdriver> is in "echo" mode, and Bundle Protocol delivery service
 
105
has been stopped.
 
106
 
 
107
=back
 
108
 
 
109
=head1 BUGS
 
110
 
 
111
Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>
 
112
 
 
113
=head1 SEE ALSO
 
114
 
 
115
bpadmin(1), bpcounter(1), bpecho(1), bp(3)