rclpy.endpoint_info module

class rclpy.endpoint_info.EndpointTypeEnum(*values)

Bases: IntEnum

Enum for possible types of topic endpoints.

This enum matches the one defined in rmw/types.h

CLIENT = 3

INVALID = 0

PUBLISHER = 1

SERVER = 4

SUBSCRIPTION = 2

class rclpy.endpoint_info.ServiceEndpointInfo(node_name: str = '', node_namespace: str = '', service_type: str = '', service_type_hash: ~rclpy.type_hash.TypeHash | ~rclpy.type_hash.TypeHashDictionary = <rclpy.type_hash.TypeHash object>, qos_profiles: ~typing.List[rclpy.qos.QoSProfile | rpyutils.import_c_library._rmw_qos_profile_dict] = [], endpoint_gids: ~typing.List[~typing.List[int]] = [], endpoint_type: ~rclpy.endpoint_info.EndpointTypeEnum = EndpointTypeEnum.INVALID, endpoint_count: int = 0)

Bases: object

Information on a service endpoint.

property endpoint_count: int

Get field ‘node_name’.

Returns:

node_name attribute

property endpoint_gids: List[List[int]]

Get field ‘endpoint_gids’.

Returns:

endpoint_gids attribute

property endpoint_type: EndpointTypeEnum

Get field ‘endpoint_type’.

Returns:

endpoint_type attribute

property node_name: str

Get field ‘node_name’.

Returns:

node_name attribute

property node_namespace: str

Get field ‘node_namespace’.

Returns:

node_namespace attribute

property qos_profiles: List[rclpy.qos.QoSProfile]

Get field ‘qos_profile’.

Returns:

qos_profile attribute

property service_type: str

Get field ‘topic_type’.

Returns:

topic_type attribute

property service_type_hash: Any

Get field ‘service_type_hash’.

Returns:

service_type_hash attribute

class rclpy.endpoint_info.TopicEndpointInfo(node_name: str = '', node_namespace: str = '', topic_type: str = '', topic_type_hash: ~rclpy.type_hash.TypeHash | ~rclpy.type_hash.TypeHashDictionary = <rclpy.type_hash.TypeHash object>, endpoint_type: ~rclpy.endpoint_info.EndpointTypeEnum | int = EndpointTypeEnum.INVALID, endpoint_gid: ~typing.List[int] = [], qos_profile: rclpy.qos.QoSProfile | rpyutils.import_c_library._rmw_qos_profile_dict = rclpy.qos.QoSPresetProfiles.UNKNOWN.value)

Bases: object

Information on a topic endpoint.

property endpoint_gid: List[int]

Get field ‘endpoint_gid’.

Returns:

endpoint_gid attribute

property endpoint_type: Any

Get field ‘endpoint_type’.

Returns:

endpoint_type attribute

property node_name: str

Get field ‘node_name’.

Returns:

node_name attribute

property node_namespace: str

Get field ‘node_namespace’.

Returns:

node_namespace attribute

property qos_profile: Any

Get field ‘qos_profile’.

Returns:

qos_profile attribute

property topic_type: str

Get field ‘topic_type’.

Returns:

topic_type attribute

property topic_type_hash: Any

Get field ‘topic_type_hash’.

Returns:

topic_type_hash attribute