niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge remote-tracking branch 'upstream/master' into security

Browse source
This commit is contained in:
Erik Boasson 2020-05-11 15:05:46 +02:00
commit 2da100a3c7
35 changed files with 671 additions and 157 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/manual/CMakeLists.txt
View file

@ -1,23 +0,0 @@
#
# Copyright(c) 2006 to 2019 ADLINK Technology Limited and others
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v. 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
# v. 1.0 which is available at
# http://www.eclipse.org/org/documents/edl-v10.php.
#
# SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
if(BUILD_DOCS)
find_package(Sphinx REQUIRED breathe)
sphinx_add_docs(
docs
BREATHE_PROJECTS ddsc_api_docs
BUILDER html
SOURCE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
install(
DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/docs/"
DESTINATION "${CMAKE_INSTALL_DOCDIR}/manual"
COMPONENT dev)
endif()

2
docs/manual/GettingStartedGuide/helloworld_indepth.rst
View file

@ -377,7 +377,7 @@ can be done to properly connect readers and writers:
The use of these events will be outside the scope of this example
* Poll for the publication/subscription matches statusses
* Poll for the publication/subscription matches statuses
* The Subscriber should poll for a subscription matched status to be set
* The Publisher should poll for a publication matched status to be set

6
docs/manual/config.rst
View file

@ -106,7 +106,7 @@ from its WHC when it fills up too far, and allows readers to always receive all
complication exists in the case of unresponsive readers, readers that do not respond to
a Heartbeat at all, or that for some reason fail to receive some samples despite
resending it. The specification leaves the way these get treated unspecified. The
default beahviour of Eclipse Cyclone DDS is to never consider readers unresponsive, but it can
default behaviour of Eclipse Cyclone DDS is to never consider readers unresponsive, but it can
be configured to consider them so after a certain length of time has passed at which
point the participant containing the reader is undiscovered.
@ -214,7 +214,7 @@ settings.
Proxies have the same natural hierarchy that ‘normal’ DDSI entities have: each proxy
endpoint is owned by some proxy participant, and once the proxy participant is deleted,
all of its proxy endpoints are deleted as well. Participants assert their liveliness
periodically (called *automic* liveliness in the DCPS specification and the only mode
periodically (called *automatic* liveliness in the DCPS specification and the only mode
currently supported by Eclipse Cyclone DDS), and when nothing has been heard from a participant
for the lease duration published by that participant in its SPDP message, the lease
becomes expired triggering a clean-up.
@ -807,7 +807,7 @@ size of the second to ``Internal/SecondaryReorderMaxSamples``.
In between the receive thread and the delivery threads sit queues, of which the maximum
size is controlled by the ``Internal/DeliveryQueueMaxSamples`` setting. Generally there
is no need for these queues to be very large (unless one has very small samples in very
large messaegs), their primary function is to smooth out the processing when batches of
large messages), their primary function is to smooth out the processing when batches of
samples become available at once, for example following a retransmission.
When any of these receive buffers hit their size limit and it concerns application data,

20
docs/manual/options.md
View file

@ -64,7 +64,7 @@ One of: false, true, single, none, many
This option specifies whether a network socket will be created for each
domain participant on a host. The specification seems to assume that each
participant has a unique address, and setting this option will ensure
this to be the case. This is not the defeault.
this to be the case. This is not the default.
Disabling it slightly improves performance and reduces network traffic
somewhat. It also causes the set of port numbers needed by Cyclone DDS to
@ -644,7 +644,7 @@ The default value is: "0".
##### //CycloneDDS/Domain/Discovery/Ports/ParticipantGain
Integer
This element specifies the participant gain, relating p0, articipant
This element specifies the participant gain, relating p0, participant
index to sets of port numbers (refer to the DDSI 2.1 specification,
section 9.6.1, constant PG).
@ -1050,8 +1050,8 @@ Attributes: [max](#cycloneddsdomaininternalheartbeatintervalmax), [min](#cyclone
Number-with-unit
This elemnents allows configuring the base interval for sending writer
heartbeats and the bounds within it can vary.
This element allows configuring the base interval for sending writer
heartbeats and the bounds within which it can vary.
Valid values are finite durations with an explicit unit or the keyword
'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
@ -1600,8 +1600,8 @@ transport. Enabling write batching causes multiple small write operations
to be aggregated within the write cache into a single larger write. This
gives greater throughput at the expense of latency. Currently there is no
mechanism for the write cache to automatically flush itself, so that if
write batching is enabled, the application may havee to use the
dds_write_flush function to ensure thta all samples are written.
write batching is enabled, the application may have to use the
dds_write_flush function to ensure that all samples are written.
The default value is: "false".
@ -2140,10 +2140,10 @@ Text
This option specifies the file to which received and sent packets will be
logged in the "pcap" format suitable for analysis using common networking
tools, such as WireShark. IP and UDP headers are ficitious, in particular
the destination address of received packets. The TTL may be used to
distinguish between sent and received packets: it is 255 for sent packets
and 128 for received ones. Currently IPv4 only.
tools, such as WireShark. IP and UDP headers are fictitious, in
particular the destination address of received packets. The TTL may be
used to distinguish between sent and received packets: it is 255 for sent
packets and 128 for received ones. Currently IPv4 only.
The default value is: "".