Entry

Summary

Represents a SOME/IP Entry object.

See also

Option

Methods: Entry.add_ipv4_option()

Entry.contains_op()

Entry.set_option_tcp()

Entry.set_option_tcp_by_instance_id()

Entry.set_option_udp()

Entry.set_option_udp_by_instance_id()
Properties: Entry.counter

Entry.entry_type

Entry.event_group_id

Entry.flag_op_1

Entry.flag_op_2

Entry.index_op_1

Entry.index_op_2

Entry.initial_data_req

Entry.instance_id

Entry.major_version

Entry.minor_version

Entry.options

Entry.reserved

Entry.reserved2

Entry.service_id

Entry.string_entry_type

Entry.ttl

Entry.type

Structure

class Entry

add_ipv4_option(port: uint16, address: str, is_udp: bool, is_multicast: bool) → Option

Creates an IPv4 endpoint option over UDP or TCP from the parameters given and attaches it to the entry, updating the corresponding fields (index and number of options) to reflect the addition.

Parameters

port (uint16) – UDP or TCP port number.
address (str) – IPv4 address.
is_udp (bool) – True if it’s over UDP . False otherwise.
is_multicast (bool) – True if the option is used in a SusbcribeEventgroupAck entry to indicate that the events/methods of the subscribed service will be sent multicast.:code:False otherwise.

Returns

IPv4 endpoint option over UDP or TCP.

Return type

Option

contains_op(option: Option) → bool

Verifies if the put option put it in parameter exists in option list

Parameters: option (Option) – Option to set.
Returns: The index of option in option list. -1 if it does not exist.
Return type: bool

set_option_tcp(port: uint16, address: str, isMulticast: bool)

Creates an IPv4 endpoint option over TCP from the parameters given and attaches it to the entry, updating the corresponding fields(index and number of options) to reflect the addition.

Parameters

port (uint16) – TCP port number.
address (str) – IPv4 address.
isMulticast (bool) – True if the option is used in a SusbcribeEventgroupAck entry to indicate that the events/methods of the subscribed

set_option_tcp_by_instance_id() → bool

Creates an IPv4 endpoint option over TCP from the info found in the Fibex database for the service id and instance id of the entry and attaches it to the entry. To get that, it performs the following actions, It searches the Fibex database for the service instance associated to the instance id and service id of the entry, then checks if this service instance has TCP among the defined transport protocols, If so, it gets the IP address and TCP port from this service instance, With the gathered info, it creates the TCP IPv4 endpoint option and adds it to the entry.

Returns: True if the option could be successfully added. False otherwise.
Return type: bool

set_option_udp(port: uint16, address: str, isMulticast: bool)

Creates an IPv4 endpoint option over UDP from the parameters given and attaches it to the entry, updating the corresponding fields(index and number of options) to reflect the addition.

Parameters

port (uint16) – UDP port number.
address (str) – IPv4 address.
isMulticast (bool) – True if the option is used in a SusbcribeEventgroupAck entry to indicate that the events/methods of the subscribed.

set_option_udp_by_instance_id() → bool

Creates an IPv4 endpoint option over UDP from the info found in the Fibex database for the service id and instance id of the entry and attaches it to the entry. To get that, it performs the following actions, It searches the Fibex database for the service instance associated to the instance id and service id of the entry, then checks if this service instance has UDP among the defined transport protocols, If so, it gets the IP address and UDP port from this service instance, With the gathered info, it creates the UDP IPv4 endpoint option and adds it to the entry.

Returns: True if the option could be successfully added. False otherwise.
Return type: bool

counter

Counter : Is used to differentiate identical Subscribe Eventgroups of the same subscriber. Set to 0x0 if not used.