Option

Summary

Represents a SOME/IP options object.

See also

Entry

Methods: Option.get_default_option_length()

Option.is_configuration_string()

Option.is_endpoint()

Option.is_ipv4()

Option.is_ipv4_endpoint()

Option.is_ipv4_multicast()

Option.is_ipv6()

Option.is_ipv6_endpoint()

Option.is_ipv6_multicast()

Option.is_multicast()
Properties: Option.configuration

Option.endpoint_type

Option.index

Option.ip_address

Option.ipv6_address

Option.length

Option.option_port

Option.option_type

Option.protocol

Option.reserved_byte

Option.Type

Structure

class Option

get_default_option_length() → uint16

Returns the default option's length.

Returns: Default option's length.
Return type: uint16

is_configuration_string() → bool

Checks if the option is of type “configuration string”

Returns: True if the option is of type “configuration string”. False otherwise.
Return type: bool

is_endpoint() → bool

Checks if the type of the option is “ipv4_endpoint” or “ipv6_endpoint”.

Returns: True if the option is of type “endpoint”, either IPv4 or IPv6. False otherwise.
Return type: bool

is_ipv4() → bool

Checks if the option references an IPv4 address, either endpoint or multicast.

Returns: True if the option refers to an IPv4 address. False otherwise.
Return type: bool

is_ipv4_endpoint() → bool

Checks if the option is exclusively of type “ipv4_multicast”.

Returns: True if the option is an IPv4 multicast address. False otherwise.
Return type: bool

is_ipv4_multicast() → bool

Checks if the option is exclusively of type “ipv4_multicast”.

Returns: True if the option is an IPv4 multicast address. False otherwise.
Return type: bool

is_ipv6() → bool

Checks if the option references an IPv6 address, either endpoint or multicast.

Returns: True if the option refers to an IPv6 address. False otherwise.
Return type: bool

is_ipv6_endpoint() → bool

Checks if the option is exclusively of type “ipv6_endpoint”.

Returns: True if the option is an IPv6 endpoint address. False otherwise.
Return type: bool

is_ipv6_multicast() → bool

Checks if the option is exclusively of type “ipv6_multicast”.

Returns: True if the option is an IPv6 multicast address. False otherwise.
Return type: bool

is_multicast() → bool

Checks if the option is exclusively of type “ipv4_multicast” or “ipv6_multicast”.

Returns: True if the option is of type “multicast”, either IPv4 or IPv6.:code:False otherwise.
Return type: bool

configuration

Content of a configuration string option.

Type: str

endpoint_type

EndPointType represents the type of option .

Type: EndPointType

index

The index of the option.

Type: int32

ip_address

IPv4 address of an endpoint or multicast option, used in the IP layer of the SOME/IP messages sent after subscribing to the corresponding service.

Type: str

ipv6_address

IPv6 address of an endpoint or multicast option, used in the IP layer of the SOME/IP messages sent after subscribing to the corresponding service.

Type: str

length

Length of the option in bytes.

Type: uint16 or None

option_port

Port number of an endpoint or multicast option, used for the transport layer of the SOME/IP messages sent after subscribing to the corresponding service.

Type: uint16

option_type

Byte represents the type of the option.

Type: uint8

protocol

Byte represents the L4-protocol used.

Type: uint8

reserved_byte

Reserved byte to possible uses in the future. It shall be set to 0x00 until further notice

Type: uint8

Type

OPTION_TRANSPORT_PROTOCOL represents the L4-protocol used.

Type: TransType