← Back to branch summary

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

« back to all changes in this revision

Viewing changes to bp/doc/pod1/stcpclo.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/stcpclo.pod
 
1
=head1 NAME
 
2
 
 
3
stcpclo - DTN simple TCP convergence layer adapter output task
 
4
 
 
5
=head1 SYNOPSIS
 
6
 
 
7
B<stcpclo> I<remote_hostname>[:I<remote_port_nbr>]
 
8
 
 
9
=head1 DESCRIPTION
 
10
 
 
11
B<stcpclo> is a background "daemon" task that connects to a remote node's
 
12
TCP socket at I<remote_hostname> and I<remote_port_nbr>.  It then begins
 
13
extracting bundles from the queues of bundles ready for transmission via
 
14
TCP to this remote bundle protocol agent and transmitting those bundles
 
15
over the connected socket to that node.  Each transmitted bundle is
 
16
preceded by a 32-bit integer in network byte order indicating the length
 
17
of the bundle.
 
18
 
 
19
If not specified, I<remote_port_nbr> defaults to 4556.
 
20
 
 
21
Note that B<stcpclo> is not a "promiscuous" convergence layer daemon: it
 
22
can transmit bundles only to the node to which it is connected, so
 
23
scheme configuration directives that cite this outduct need only provide
 
24
the protocol name and the outduct name as specified on the command line
 
25
when B<stcpclo> is started.
 
26
 
 
27
B<stcpclo> is spawned automatically by B<bpadmin> in response to the 's' (START)
 
28
command that starts operation of the Bundle Protocol, and it is terminated by
 
29
B<bpadmin> in response to an 'x' (STOP) command.  B<stcpclo> can also be
 
30
spawned and terminated in response to START and STOP commands that pertain
 
31
specifically to the STCP convergence layer protocol.
 
32
 
 
33
=head1 EXIT STATUS
 
34
 
 
35
=over 4
 
36
 
 
37
=item 0
 
38
 
 
39
B<stcpclo> terminated normally, for reasons noted in the B<ion.log> file.  If
 
40
this termination was not commanded, investigate and solve the problem identified
 
41
in the log file and use B<bpadmin> to restart the STCP protocol.
 
42
 
 
43
=item 1
 
44
 
 
45
B<stcpclo> terminated abnormally, for reasons noted in the B<ion.log> file.
 
46
Investigate and solve the problem identified in the log file, then use
 
47
B<bpadmin> to restart the STCP protocol.
 
48
 
 
49
=back
 
50
 
 
51
=head1 FILES
 
52
 
 
53
No configuration files are needed.
 
54
 
 
55
=head1 ENVIRONMENT
 
56
 
 
57
No environment variables apply.
 
58
 
 
59
=head1 DIAGNOSTICS
 
60
 
 
61
The following diagnostics may be issued to the B<ion.log> log file:
 
62
 
 
63
=over 4
 
64
 
 
65
=item stcpclo can't attach to BP.
 
66
 
 
67
B<bpadmin> has not yet initialized Bundle Protocol operations.
 
68
 
 
69
=item No such stcp duct.
 
70
 
 
71
No STCP outduct with duct name matching I<remote_hostname> and
 
72
I<remote_port_nbr> has been added to the BP database.  Use B<bpadmin> to
 
73
stop the STCP convergence-layer protocol, add the outduct, and then restart the
 
74
STCP protocol.
 
75
 
 
76
=item CLO task is already started for this duct.
 
77
 
 
78
Redundant initiation of B<stcpclo>.
 
79
 
 
80
=item Can't get IP address for host
 
81
 
 
82
Operating system error.  Check errtext, correct problem, and restart STCP.
 
83
 
 
84
=back
 
85
 
 
86
=head1 BUGS
 
87
 
 
88
Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>
 
89
 
 
90
=head1 SEE ALSO
 
91
 
 
92
bpadmin(1), bprc(5), stcpcli(1)