NAME
cd11rcv2orb - Receive CD1.1 packets via CD1.1 Protocol and deliver to orbserver
SYNOPSIS
cd11rcv2orb [-v[v[v[v]]]] [-n] [-p pf] [-P listener_port] [-R [receiver_ip:]receiver_port] [-S statefile] orbname
DESCRIPTION
The
cd11rcv2orb program serves as a CD1.1
data consumer (as defined
by the
IDC 3.4.3 document cited below), reading CD1.1 format data frames
via CD1.1 protocol and saving them on an Antelope
orbserver(1) specified
by
orbname.
All waveform data taken in via CD1.1 protocol are put on the
orbserver(1) specified by
orbname in
.*/CD11 packet format.
Signature verification for packet authentication is outsourced to an instance of the
versignd(1) daemon, which must be running in order for
cd11rcv2orb to function.
An authentication key identifier, specified in the
cd11rcv2orb parameter file, is given
to
versignd(1) to identify the authentication protocol to be used. Outgoing packets,
such as CD1.1
Connection Response and
AckNack packets, are signed via the same
method.
OPTIONS
-
-n
Test mode: ignore authentication on incoming packets
-
-p pf
Parameter file name. If omitted, this defaults to cd11rcv2orb.pf.
-
-P listener_port
Specify the TCP port number on which cd11rcv2orb listens for incoming connections. If not
set, this defaults to TCP port 12476.
-
-R [receiver_ip:]receiver_port
Specify the starting TCP port number which cd11rcv2orb proposes and uses for actual CD1.1 data flow.
If not set, this defaults to TCP port 12477. If the port number is preceded by an IP-address and colon,
that IP address is used in CD1.1 Connection Response frames to represent the responder IP address for the
assigned port, for cases in which cd11rcv2orb is running on a private network behind a
Network-Address-Translated firewall. Successive connections increment this number by 1, through a range up to
the starting port plus the value of the max_connections parameter-file parameter, re-using previous no-longer-used
ports after that.
-
-S statefile
Statefile name. If this is specified, cd11rcv2orb keeps a non-volatile list of all gaps in the data
stream (CD1.1 sequence numbers missing for each incoming station) which it uses to request re-transmission
via CD1.1 AckNack packets.
-
-v[v[v[v]]]
Verbose. Increasing numbers of v options increase the level of verbosity. With four v's,
printed summaries of all CD11 packets are dumped to stderr.
PARAMETER FILE
Parameter File Parameters
-
auth_key_identifier
This integer is given to the versignd(1) daemon for packet authentication.
-
frame_creator
This string gives the name of the CD1.1 frame creator, embedded in transmitted packets per the CD1.1 protocol.
-
frame_destination
This string gives the destination name for CD1.1 protocol packets, which per protocol
should be set to 0 for multiple or unspecified destinations.
-
max_connections
This integer parameter gives the maximum allowed number of simultaneous receive connections
-
networks
This array associates the name of each expected incoming station as a key, with the value of the network code for
that station. This is necessary since SEED network codes used within Antelope are not included in CD1.1 packets.
The networks array must have an entry for a station named default, which is used if no exact match
for the incoming station is found in the rest of the networks array.
-
series_number
This integer parameter gives the series number embedded in CD1.1 packet headers.
-
socket_backlog
This integer specifies the size of the allowed socket backlog on the main socket listening for incoming connections
-
time_intervals_sec
This array contains any time-interval configuration parameters for cd11rcv2orb
-
time_intervals_sec{acknack_interval}
CD1.1 AckNack frames are sent with this specified interval
-
time_intervals_sec{assignedport_maxwait}
This is the maximum time cd11rcv2orb will wait for a connection request on a newly assigned data port before
shutting down the assigned-port receiver.
-
time_intervals_sec{internal_timeout}
The internal_timeout value is used for a variety of purposes inside cd11rcv2orb, for example
orbreap_timeout(3) settings and bnstimeout(3) settings on the CD1.1 socket(s).
-
time_intervals_sec{statefile_age_limit}
Any State file (as specified by the -S option) will be ignored if older than this number of seconds.
-
versignd_address
This parameter gives a host:port name for a versignd(1) daemon used to create authentication
signatures for packets.
Parameter File Example
frame_creator CDRV2ORB
frame_destination 0
auth_key_identifier 1
versignd_address localhost:6511
series_number 1
max_connections 10
socket_backlog 20
networks &Arr{
# Station Network
#
BRTT BR
default XX
}
time_intervals_sec &Arr{
internal_timeout 1.0
statefile_age_limit 864000.0
assignedport_maxwait 120.0
acknack_interval 60.0
}
EXAMPLE
% cd11rcv2orb -v -P 12476 -R 12477 :
SEE ALSO
orb2cd11xmit(1), cd11(3)
CTBTO (2002). Formats and Protocols for Continuous Data CD-1.1, Document ID IDC 3.4.3,
Preparatory Commission for the Comprehensive Nuclear-test-ban Treaty Organization.
AUTHOR
Kent Lindquist