rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
Classes | Macros | Typedefs | Enumerations | Variables
types.h File Reference
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "rmw/visibility_control.h"

Go to the source code of this file.

Classes

struct  rmw_node_t
 
struct  rmw_publisher_t
 
struct  rmw_subscription_t
 
struct  rmw_service_t
 
struct  rmw_client_t
 
struct  rmw_guard_condition_t
 
struct  rmw_subscriptions_t
 Array of subsciber handles. More...
 
struct  rmw_services_t
 Array of service handles. More...
 
struct  rmw_clients_t
 Array of client handles. More...
 
struct  rmw_guard_conditions_t
 Array of guard condition handles. More...
 
struct  rmw_waitset_t
 
struct  rmw_request_id_t
 
struct  rmw_time_t
 
struct  rmw_node_security_options_t
 
struct  rmw_qos_profile_t
 
struct  rmw_gid_t
 
struct  rmw_message_info_t
 

Macros

#define RMW_RET_OK   0
 
#define RMW_RET_ERROR   1
 
#define RMW_RET_TIMEOUT   2
 
#define RMW_RET_BAD_ALLOC   10
 Failed to allocate memory return code. More...
 
#define RMW_RET_INVALID_ARGUMENT   11
 Invalid argument return code. More...
 
#define RMW_GID_STORAGE_SIZE   24
 

Typedefs

typedef int rmw_ret_t
 
typedef struct RMW_PUBLIC_TYPE rmw_node_t rmw_node_t
 
typedef struct RMW_PUBLIC_TYPE rmw_publisher_t rmw_publisher_t
 
typedef struct RMW_PUBLIC_TYPE rmw_subscription_t rmw_subscription_t
 
typedef struct RMW_PUBLIC_TYPE rmw_service_t rmw_service_t
 
typedef struct RMW_PUBLIC_TYPE rmw_client_t rmw_client_t
 
typedef struct RMW_PUBLIC_TYPE rmw_guard_condition_t rmw_guard_condition_t
 
typedef struct RMW_PUBLIC_TYPE rmw_subscriptions_t rmw_subscriptions_t
 Array of subsciber handles. More...
 
typedef struct RMW_PUBLIC_TYPE rmw_services_t rmw_services_t
 Array of service handles. More...
 
typedef struct RMW_PUBLIC_TYPE rmw_clients_t rmw_clients_t
 Array of client handles. More...
 
typedef struct RMW_PUBLIC_TYPE rmw_guard_conditions_t rmw_guard_conditions_t
 Array of guard condition handles. More...
 
typedef struct RMW_PUBLIC_TYPE rmw_waitset_t rmw_waitset_t
 
typedef struct RMW_PUBLIC_TYPE rmw_request_id_t rmw_request_id_t
 
typedef struct RMW_PUBLIC_TYPE rmw_time_t rmw_time_t
 
typedef struct RMW_PUBLIC_TYPE rmw_node_security_options_t rmw_node_security_options_t
 
typedef struct RMW_PUBLIC_TYPE rmw_qos_profile_t rmw_qos_profile_t
 
typedef struct RMW_PUBLIC_TYPE rmw_gid_t rmw_gid_t
 
typedef struct RMW_PUBLIC_TYPE rmw_message_info_t rmw_message_info_t
 

Enumerations

enum  { RMW_QOS_POLICY_DEPTH_SYSTEM_DEFAULT = 0 }
 

Variables

enum RMW_PUBLIC_TYPE rmw_security_enforcement_policy_t
 
 RMW_SECURITY_ENFORCEMENT_PERMISSIVE
 
 RMW_SECURITY_ENFORCEMENT_ENFORCE
 
enum RMW_PUBLIC_TYPE rmw_qos_reliability_policy_t
 
 RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT
 
 RMW_QOS_POLICY_RELIABILITY_RELIABLE
 
enum RMW_PUBLIC_TYPE rmw_qos_history_policy_t
 
 RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT
 
 RMW_QOS_POLICY_HISTORY_KEEP_LAST
 
enum RMW_PUBLIC_TYPE rmw_qos_durability_policy_t
 
 RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT
 
 RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL
 

Macro Definition Documentation

◆ RMW_RET_OK

#define RMW_RET_OK   0

◆ RMW_RET_ERROR

#define RMW_RET_ERROR   1

◆ RMW_RET_TIMEOUT

#define RMW_RET_TIMEOUT   2

◆ RMW_RET_BAD_ALLOC

#define RMW_RET_BAD_ALLOC   10

Failed to allocate memory return code.

◆ RMW_RET_INVALID_ARGUMENT

#define RMW_RET_INVALID_ARGUMENT   11

Invalid argument return code.

◆ RMW_GID_STORAGE_SIZE

#define RMW_GID_STORAGE_SIZE   24

Typedef Documentation

◆ rmw_ret_t

typedef int rmw_ret_t

◆ rmw_node_t

◆ rmw_publisher_t

◆ rmw_subscription_t

◆ rmw_service_t

◆ rmw_client_t

◆ rmw_guard_condition_t

◆ rmw_subscriptions_t

Array of subsciber handles.

An array of void * pointers representing type-erased middleware-specific subscriptions. The number of non-null entries may be smaller than the allocated size of the array. The number of subscriptions represented may be smaller than the allocated size of the array. The creator of this struct is responsible for allocating and deallocating the array.

◆ rmw_services_t

Array of service handles.

An array of void * pointers representing type-erased middleware-specific services. The number of non-null entries may be smaller than the allocated size of the array. The number of services represented may be smaller than the allocated size of the array. The creator of this struct is responsible for allocating and deallocating the array.

◆ rmw_clients_t

Array of client handles.

An array of void * pointers representing type-erased middleware-specific clients. The number of non-null entries may be smaller than the allocated size of the array. The number of clients represented may be smaller than the allocated size of the array. The creator of this struct is responsible for allocating and deallocating the array.

◆ rmw_guard_conditions_t

Array of guard condition handles.

An array of void * pointers representing type-erased middleware-specific guard conditions. The number of non-null entries may be smaller than the allocated size of the array. The number of guard conditions represented may be smaller than the allocated size of the array. The creator of this struct is responsible for allocating and deallocating the array.

◆ rmw_waitset_t

◆ rmw_request_id_t

◆ rmw_time_t

◆ rmw_node_security_options_t

◆ rmw_qos_profile_t

◆ rmw_gid_t

◆ rmw_message_info_t

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
RMW_QOS_POLICY_DEPTH_SYSTEM_DEFAULT 

Variable Documentation

◆ rmw_security_enforcement_policy_t

enum RMW_PUBLIC_TYPE rmw_security_enforcement_policy_t

◆ RMW_SECURITY_ENFORCEMENT_PERMISSIVE

RMW_SECURITY_ENFORCEMENT_PERMISSIVE

◆ RMW_SECURITY_ENFORCEMENT_ENFORCE

RMW_SECURITY_ENFORCEMENT_ENFORCE

◆ rmw_qos_reliability_policy_t

enum RMW_PUBLIC_TYPE rmw_qos_reliability_policy_t

◆ RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT

RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT

◆ RMW_QOS_POLICY_RELIABILITY_RELIABLE

RMW_QOS_POLICY_RELIABILITY_RELIABLE

◆ rmw_qos_history_policy_t

enum RMW_PUBLIC_TYPE rmw_qos_history_policy_t

◆ RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT

RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT

◆ RMW_QOS_POLICY_HISTORY_KEEP_LAST

RMW_QOS_POLICY_HISTORY_KEEP_LAST

◆ rmw_qos_durability_policy_t

enum RMW_PUBLIC_TYPE rmw_qos_durability_policy_t

◆ RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT

RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT

◆ RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL

RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL