Npdu Cantp Module

class mtf.network_port.iso_tp.Npdu_can_tp.npdu_cantp.NpduCanTp

A class representing the NPDU CanTp interface.

__init__()

Constructor for NPDU CanTp class. Initializes an instance of NPDU CanTp.

Args:

None

Returns:

None

send(payload: list)

Sends a payload using the configured NPDU can tp connection.

Args:

payload (list): The payload to be sent.

Returns:

None or bool: Returns None if the controller is not configured,

else returns the result of the controller’s transmit method.

close()

Closes the NPDU CanTp instance and cleans up the controller.

Args:

None

Returns:

bool: True if successfully closed, False otherwise.

recv()

Receives a frame from the configured controller.

Args:

None

Returns:

None or received_frame: None if no frame received, else the received frame.

Configure(source_tunnel: str, source_pdu_id: int, target_tunnel: str, target_pdu_id: int, tx_pdu_length: int, flow_timeout: int, padding: int, *args, **kwargs)

Configures the NPDU CanTp communication with specified parameters. This function is used to configure the NPDU CANTP connection by specifying the connection parameters.

Args:

source_tunnel (str): Name of the source tunnel. source_pdu_id (int): Source PDU frame ID. target_tunnel (str): Name of the target tunnel. target_pdu_id (int): Target PDU frame ID. tx_pdu_length (int): Target pdu length. flow_timeout (int): Flow timeout. padding (int): Padding value.

Returns:

bool: True if successful, False otherwise.

get_npdu_can_tp_queue()

Gets the NPDU CanTp queue.

Returns:

list: The CanTp queue.

reset_npdu_can_tp_queue()

Resets the NPDU CanTp queue.

Returns:

None

clean_up()

Performs cleanup for the NPDU CanTp instance.

Returns:

bool: True if successful, False otherwise.

static __new__(cls, *args, **kwargs)

Initializes a new instance of the ControllerBase.

The instance will be automatically added to the list of controllers to be cleaned up later. It guarantees that all the controller instances are followed up and cleaned up when the associate method ‘controllers_cleanup(cls)’ is called.

Note:

Do not override this method in subclasses to maintain this functionality.

Args:

*args: Suitable arguments passed to the constructor of the ControllerBase class. **kwargs: keywords passed to the constructor of the ControllerBase class.

Returns:

instance(ControllerBase): The new instance of the class that has been created.

bind(interface, address, *args, **kwargs)

classmethod controllers_cleanup()

Cleans up all controller instances.

It Calls the clean_up() method for each instance, since it iterates through the list of controllers to realize any needed cleanup which can fail so an error will be raised. Then, the remaining instances will continue processing.

Returns:

bool: True indicating that all the controllers are successfully cleaned up, otherwise False when an error occurred during the operation of the cleanup.