Add documentation

This commit is contained in:
Greek 2021-11-17 14:27:30 +01:00
parent 9cc4907a2f
commit 8f9f445f21
6 changed files with 26 additions and 5 deletions

BIN
doc/DDSI-RTPS_2-5.pdf (Stored with Git LFS) Normal file

Binary file not shown.

BIN
doc/DDSI-RTPS_2-5_diff.pdf (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -4,9 +4,24 @@
|DDS Writer|->|History Cache|->|RTPS Writer|<-->|RTPS Reader|->|History Cache|->|DDS Reader|
+----------+ +-------------+ +-----------+ +-----------+ +-------------+ +----------+
+----------+ +-----------+ +------------+ +------------+ +-----------+ +----------+
|DDS Writer|->|RTPS Writer|<-+->|RTPS Handler|<-->|RTPS Handler|<-+->|RTPS Reader|->|DDS Reader|
+----------+ +-----------+ | +------------+ +------------+ | +-----------+ +----------+
+---------------------+ | | +---------------------+
|RTPS Builtin Endpoint|<-+ +->|RTPS Builtin Endpoint|
+---------------------+ +---------------------+
+----------+ +-----------+ +------------+ +------------+ +-----------+ +----------+
| | | |<-+----|RTPS Handler|<---| RTPS OUT |<-+----| | | |
|DDS Writer|->|RTPS Writer| | +------------+ +------------+ | |RTPS Reader|->|DDS Reader|
| | | |--|-+ | +->| | | |
+----------+ +-----------+ | | | | +-----------+ +----------+
+---------------------+ | | | | +---------------------+
| |<-+ | +-|--| |
|RTPS Builtin Endpoint| | +------------+ +------------+ | |RTPS Builtin Endpoint|
| |----+->| RTPS OUT |--->|RTPS Handler|----+->| |
+---------------------+ +------------+ +------------+ +---------------------+
TODO: RTPS Reader/Writer and RTPS Builtin Endpoint Interconnection

View File

@ -209,7 +209,7 @@ DESIGN DECISIONS
matched local endpoints. This decision was reverted, and we just sent MATCH frames to the currently
matched local endpoints (non depending on if they are already matched) and UNMATCH frames to the
rest of the local endpoints (non depending on if they were previously matched).
So we basically push the responsibility to the local endpoints, which have to handle this situations
So we basically push the responsibility to the local endpoints, which have to handle these situations
accordingly. Since META traffic is not supposed to be generated as often, this should not produce
any significant overhead. As optimization, on new matched remote endpoints UNMATCH frames can be
ignored.

View File

@ -15,11 +15,11 @@ use work.rtps_test_package.all;
-- Add 2 random sized packets to random input port t1. After t1 is beginning being processed add 2 random sized packets to a random input port t2 that is after the t1 input port,
-- and add 2 random sized packets to a random input port t3 that is before the t1 input port. The packets should come in order : t1p1, t2p1, t3p1, t1p2, t2p2, t3p2.
-- TEST 2
-- Add 4 packets with sizes 4-Bytes, 3-Bytes, 2-Bytes, and 1-Bytes respectively to the input port t1. Add a maximum size packet at input port t2, and a oversized (over maximum size)
-- Add 4 packets with sizes 4-Bytes, 3-Bytes, 2-Bytes, and 1-Bytes respectively to the input port t1. Add a maximum size packet at input port t2, and an oversized (over maximum size)
-- at input port t3. The expected order should be: t1p1, t2p1.
-- Note that during the beginning of this test the UUT should be processing input port t3.
-- TEST 3
-- Add one random sized packet to each available input port. The expected order is: t1+1p1, t1+2p1,...,t1p1.
-- Add one random sized packet to each available input port. The expected order is: (t1+1)p1, (t1+2)p1,...,t1p1.
-- Note that during the beginning of this test the UUT should be processing input port t1.
entity L0_rtps_out_test1 is

View File

@ -58,7 +58,7 @@ package rtps_package is
constant VIEW_STATE_KIND_WIDTH : natural := CDR_LONG_WIDTH;
constant INSTANCE_STATE_KIND_WIDTH : natural := CDR_LONG_WIDTH;
constant QOS_POLICY_ID_WIDTH : natural := CDR_LONG_WIDTH;
constant MAX_SAMPLES_WIDTH : natural := CDR_LONG_WIDTH;
constant MAX_SAMPLES_WIDTH : natural := CDR_LONG_WIDTH; -- TODO: Not used. Needed?
constant DISPOSED_GENERATION_COUNT_WIDTH : natural := CDR_LONG_WIDTH;
constant NO_WRITERS_GENERATION_COUNT_WIDTH : natural := CDR_LONG_WIDTH;