MessageBuilder

Summary

Represents Message Builder for standard protocols that are supported by ANDi.

Methods

Structure

class MessageBuilder
create_1722_message(sender: object = None, receiver: object = None) MessageIEEE1722

Creates an IEEE1722 message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageIEEE1722

create_analog_message(sender: object = None, receiver: object = None) MessageAnalog

Creates an analog message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageAnalog

create_arp_message(sender: object = None, receiver: object = None) MessageARP

Creates an ARP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the

Returns

Message object created.

Return type

MessageARP

create_can_message(sender: object = None, receiver: object = None) MessageCAN

Creates a CAN message object.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageCAN

create_dhcp_message(sender: object = None, receiver: object = None) MessageDHCP

Creates a DHCP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageDHCP

create_dlt_message(sender: object = None, receiver: object = None) MessageDlt

Creates a DLT message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive the message.

Returns

Message object created

Return type

MessageDlt

create_doip_message(sender: object = None, receiver: object = None) IMessageDiagBasic

Creates a DoIP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message.

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

IMessageDiagBasic

create_ethernet_message(sender: object = None, receiver: object = None) MessageEthernet

Creates an Ethernet message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageEthernet

create_flexray_message(sender: object = None, receiver: object = None) MessageFlexray

Creates a FlexRay message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageFlexray

create_hsfz_message(sender: object = None, receiver: object = None) MessageHSFZ

Creates a HSFZ message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageHSFZ

create_http_message(sender: object = None, receiver: object = None) MessageHttp

Creates a HTTP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageHttp

create_icmp_message(sender: object = None, receiver: object = None) MessageICMPv4

Creates an ICMP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageICMPv4

create_icmpv6_message(sender: object = None, receiver: object = None) MessageICMPv6

Creates an ICMPV6 message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageICMPv6

create_ip_message(sender: object = None, receiver: object = None) MessageIpv4

Creates an IP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageIpv4

create_ipv6_message(sender: object = None, receiver: object = None) MessageIPv6

Creates an IPV6 message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageIPv6

create_lin_message(sender: object = None, receiver: object = None) MessageLIN

Creates a LIN message object.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageLIN

create_mmrp_message(sender: object = None, receiver: object = None) MessageSRP

Creates an SRP message object with default values in its fields using a MAC base.

Parameters
  • sender (object) – network adapter used to send the message.

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageSRP

create_mvrp_message(sender: object = None, receiver: object = None) MessageSRP

Creates an SRP message object with default values in its fields using a VLAN base.

Parameters
  • sender (object) – network adapter used to send the message.

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageSRP

create_pdu_message(sender: object = None, receiver: object = None) MessagePDU

Creates a PDU message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessagePDU

create_ptp_message(sender: object = None, receiver: object = None) MessagePTP

Creates a PTP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessagePTP

create_someip_message(sender: object = None, receiver: object = None) MessageSomeIP

Creates a SOME/IP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageSomeIP

create_someip_sd_message(sender: object = None, receiver: object = None) MessageSomeIPSD

Creates a SOME/IP-SD message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageSomeIPSD

create_tcp_message(sender: object = None, receiver: object = None) MessageTCP

Creates a TCP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageTCP

create_tftp_message(sender: object = None, receiver: object = None) MessageTFTP

Creates a TFTP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageTFTP

create_tls_message(sender: object = None, receiver: object = None) MessageTls

Creates a TLS message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageTls

create_udp_message(sender: object = None, receiver: object = None) MessageUDP

Creates an UDP message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageUDP

create_udp_nm_message(sender: object = None, receiver: object = None) MessageNM

Creates an UDP-NM message object with default values in its fields.

Parameters
  • sender (object) – network adapter used to send the message

  • receiver (object) – network adapter used to receive messages of the same protocol.

Returns

Message object created.

Return type

MessageNM