Skip to content

Commit

Permalink
Merge pull request #3 from us-irs/doc-corrections
Browse files Browse the repository at this point in the history
doc corrections
  • Loading branch information
robamu committed Jan 24, 2024
2 parents 21e42d9 + 242f278 commit 42afbfb
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ Example applications
=====================

You can find an example application inside the
`example directory <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-simple>`_
`example directory <https://github.com/us-irs/cfdp-py/tree/main/examples/cfdp-simple>`_
which shows an end-to-end file transfer on a host computer. This should give you a general idea of
how the source and destination handler work in practice.

There is also a
`test application <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-libre-cube-crosstest>`_
which cross-tests the `tmtccmd` CFDP implementation with the
which cross-tests the `cfdp-py` CFDP implementation with the
`Libre Cube CFDP <https://gitlab.com/librecube/lib/python-cfdp>`_ implementation.

Finally, you can see a more complex example also featuring more features of the CFDP state machines
`here <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-cli-udp>`_. This example
`here <https://github.com/us-irs/cfdp-py/tree/main/examples/cfdp-cli-udp>`_. This example
uses UDP servers for communication and explicitely separates the local and remote entity
application.
16 changes: 8 additions & 8 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ mode which includes multiple mechanism to ensure succesfull packet transaction e
connections, including lost segment detection. As such, it can be compared to a specialized TCP
for file transfers with remote systems.

The core of these high-level components are the :py:class:`tmtccmd.cfdp.handler.dest.DestHandler`
and the :py:class:`tmtccmd.cfdp.handler.source.SourceHandler` component. These model the CFDP
The core of these high-level components are the :py:class:`cfdppy.handler.dest.DestHandler`
and the :py:class:`cfdppy.handler.source.SourceHandler` component. These model the CFDP
destination and CFDP source entity respectively.

CFDP source entity
-------------------

The :py:class:`tmtccmd.cfdp.handler.source.SourceHandler` converts a
:py:class:`tmtccmd.cfdp.request.PutRequest` into all packet data units (PDUs) which need to be
The :py:class:`cfdppy.handler.source.SourceHandler` converts a
:py:class:`cfdppy.request.PutRequest` into all packet data units (PDUs) which need to be
sent to a remote CFDP entity to perform a File Copy operation to a remote entity. The source entity
allows freedom of communcation by only generating the packets required to be sent, and leaving the
actual transmission of those packets to the user. The packet is returned to the user using
the :py:class:`spacepackets.cfdp.pdu.helper.PduHolder` field of the
:py:class:`tmtccmd.cfdp.handler.source.FsmResult` structure returned in the
:py:meth:`tmtccmd.cfdp.handler.source.SourceHandler.state_machine` call.
:py:class:`cfdppy.handler.source.FsmResult` structure returned in the
:py:meth:`cfdppy.handler.source.SourceHandler.state_machine` call.

The state machine of the source entity will generally perform the following steps, after
a valid :py:class:`tmtccmd.cfdp.request.PutRequest` to perform a File Copy operation was received:
a valid :py:class:`cfdppy.request.PutRequest` to perform a File Copy operation was received:

1. Generate the Metadata PDU to be sent to a remote CFDP entity. The PDU will be returned as a
:py:class:`spacepackets.cfdp.pdu.metadata.MetadataPdu` instance.
Expand All @@ -55,7 +55,7 @@ after these steps. In any other case:
CFDP destination entity
------------------------

The :py:class:`tmtccmd.cfdp.handler.dest.DestHandler` can convert the PDUs sent from a remote
The :py:class:`cfdppy.handler.dest.DestHandler` can convert the PDUs sent from a remote
source entity ID back to a file. A file copy operation on the receiver side is started with
the reception of a Metadata PDU, for example one generated by the
:py:class:`spacepackets.cfdp.pdu.metadata.MetadataPdu` class . After that, file packet PDUs, for
Expand Down

0 comments on commit 42afbfb

Please sign in to comment.