7. Reference Guide

7.1. Proxies

7.2. Bundle Protocol

7.3. Licklider Transmission Protocol

7.4. CCSDS File Delivery Protocol

7.5. ION Memory/Storage Functions

7.6. ION Management Functions

7.7. Constants

# =========================================================================== # This file constains all the constants used in pyion # # Author: Marc Sanchez Net # Date: 04/17/2019 # Copyright (c) 2019, California Institute of Technology (“Caltech”). # U.S. Government sponsorship acknowledged. # ===========================================================================

class pyion.constants.BpAckReqEnum(value)

Bases: IntEnum

BP application acknowledgement enumeration. See help(BpAckReqEnum)

class pyion.constants.BpCustodyEnum(value)

Bases: IntEnum

BP custody switch enumeration. See help(CustodyEnum)

class pyion.constants.BpEcsEnumeration(value)

Bases: IntEnum

BP extended class-of-service enumeration. See help(BpEcsEnumeration)

• BP_MINIMUM_LATENCY: Forward bundle on all routes

• BP_BEST_EFFORT: Send using an unreliable convergence layer

• BP_RELIABLE: Send using a reliable convergence layer

class pyion.constants.BpPriorityEnum(value)

Bases: IntEnum

BP priority enumeration. See help(BpPriorityEnum)

class pyion.constants.BpReportsEnum(value)

Bases: IntEnum

BP reports enumeration. See help(BpReportsEnum)

class pyion.constants.CfdpClosure(value)

Bases: IntEnum

Length of time following transmission of the EOF PDU within which a responding Transaction Finish PDU is expected. If no Finish PDU is requested, this parameter value should be zero.

Tip

If you need a number of seconds not specified as an option in this enumeration, simply pass it directly.

class pyion.constants.CfdpConditionEnum(value)

Bases: IntEnum

CFDP condition types. See help(CfdpConditionEnum)

class pyion.constants.CfdpDeliverCodeEnum(value)

Bases: IntEnum

CFDP delivery code enumeration. See help(CfdpDeliverCodeEnum)

class pyion.constants.CfdpEventEnum(value)

Bases: IntEnum

CFDP event types. See help(CfdpEventEnum) and Section 3.5.6 of CCSDS CFDP

class pyion.constants.CfdpFileStatusEnum(value)

Bases: IntEnum

CFDP file status enumeration. See help(CfdpFileStatusEnum)

class pyion.constants.CfdpFileStoreEnum(value)

Bases: IntEnum

CFDP file store actions. See help(CfdpFileStoreEnum)

class pyion.constants.CfdpMetadataEnum(value)

Bases: IntEnum

CFDP segment metadata options. See help(CfdpMetadataEnum)

• CFDP_NO_SEG_METADATA: No metadata added

• CFDP_SEG_METADATA: Adds current time as string to all PDUs

class pyion.constants.CfdpMode(value)

Bases: IntEnum

CFDP mode enumeration. See help(CfdpMode)

• CFDP_CL_RELIABLE: Reliability provided by the convergence layer

• CFDP_UNRELIABLE: No reliability provided

• CFDP_BP_RELIABLE: Reliability provided by BP custody transfer

7.8. Utilities

# =========================================================================== # Module with utility functions and classes for pyion # # Author: Marc Sanchez Net # Date: 04/17/2019 # Copyright (c) 2019, California Institute of Technology (“Caltech”). # U.S. Government sponsorship acknowledged. # ===========================================================================

pyion.utils.check_ion_env_vars(ION_NODE_LIST_DIR)

Check the ION environment variables to ensure they are consistent (e.g., the paths set are valid and exist in the host).

Host environment variables are only utilized if the module variables pyion.ION_PWD and pyion.ION_NODE_LIST_DIR are None.