rcl  master
C API providing common ROS client library functionality.
Macros | Typedefs
types.h File Reference
#include <rmw/types.h>
Include dependency graph for types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RCL_RET_OK   RMW_RET_OK
 Success return code. More...
 
#define RCL_RET_ERROR   RMW_RET_ERROR
 Unspecified error return code. More...
 
#define RCL_RET_TIMEOUT   RMW_RET_TIMEOUT
 Timeout occurred return code. More...
 
#define RCL_RET_BAD_ALLOC   RMW_RET_BAD_ALLOC
 Failed to allocate memory return code. More...
 
#define RCL_RET_INVALID_ARGUMENT   RMW_RET_INVALID_ARGUMENT
 Invalid argument return code. More...
 
#define RCL_RET_ALREADY_INIT   100
 rcl_init() already called return code. More...
 
#define RCL_RET_NOT_INIT   101
 rcl_init() not yet called return code. More...
 
#define RCL_RET_MISMATCHED_RMW_ID   102
 Mismatched rmw identifier return code. More...
 
#define RCL_RET_TOPIC_NAME_INVALID   103
 Topic name does not pass validation. More...
 
#define RCL_RET_SERVICE_NAME_INVALID   104
 Service name (same as topic name) does not pass validation. More...
 
#define RCL_RET_UNKNOWN_SUBSTITUTION   105
 Topic name substitution is unknown. More...
 
#define RCL_RET_ALREADY_SHUTDOWN   106
 rcl_shutdown() already called return code. More...
 
#define RCL_RET_NODE_INVALID   200
 Invalid rcl_node_t given return code. More...
 
#define RCL_RET_NODE_INVALID_NAME   201
 
#define RCL_RET_NODE_INVALID_NAMESPACE   202
 
#define RCL_RET_PUBLISHER_INVALID   300
 Invalid rcl_publisher_t given return code. More...
 
#define RCL_RET_SUBSCRIPTION_INVALID   400
 Invalid rcl_subscription_t given return code. More...
 
#define RCL_RET_SUBSCRIPTION_TAKE_FAILED   401
 Failed to take a message from the subscription return code. More...
 
#define RCL_RET_CLIENT_INVALID   500
 Invalid rcl_client_t given return code. More...
 
#define RCL_RET_CLIENT_TAKE_FAILED   501
 Failed to take a response from the client return code. More...
 
#define RCL_RET_SERVICE_INVALID   600
 Invalid rcl_service_t given return code. More...
 
#define RCL_RET_SERVICE_TAKE_FAILED   601
 Failed to take a request from the service return code. More...
 
#define RCL_RET_TIMER_INVALID   800
 Invalid rcl_timer_t given return code. More...
 
#define RCL_RET_TIMER_CANCELED   801
 Given timer was canceled return code. More...
 
#define RCL_RET_WAIT_SET_INVALID   900
 Invalid rcl_wait_set_t given return code. More...
 
#define RCL_RET_WAIT_SET_EMPTY   901
 Given rcl_wait_set_t is empty return code. More...
 
#define RCL_RET_WAIT_SET_FULL   902
 Given rcl_wait_set_t is full return code. More...
 
#define RCL_RET_INVALID_REMAP_RULE   1001
 Argument is not a valid remap rule. More...
 
#define RCL_RET_WRONG_LEXEME   1002
 Expected one type of lexeme but got another. More...
 
#define RCL_RET_INVALID_PARAM_RULE   1010
 Argument is not a valid parameter rule. More...
 
#define RCL_RET_INVALID_LOG_LEVEL_RULE   1020
 Argument is not a valid log level rule. More...
 

Typedefs

typedef rmw_ret_t rcl_ret_t
 
typedef rmw_serialized_message_t rcl_serialized_message_t
 typedef for rmw_serialized_message_t; More...
 

Macro Definition Documentation

◆ RCL_RET_OK

#define RCL_RET_OK   RMW_RET_OK

Success return code.

◆ RCL_RET_ERROR

#define RCL_RET_ERROR   RMW_RET_ERROR

Unspecified error return code.

◆ RCL_RET_TIMEOUT

#define RCL_RET_TIMEOUT   RMW_RET_TIMEOUT

Timeout occurred return code.

◆ RCL_RET_BAD_ALLOC

#define RCL_RET_BAD_ALLOC   RMW_RET_BAD_ALLOC

Failed to allocate memory return code.

◆ RCL_RET_INVALID_ARGUMENT

#define RCL_RET_INVALID_ARGUMENT   RMW_RET_INVALID_ARGUMENT

Invalid argument return code.

◆ RCL_RET_ALREADY_INIT

#define RCL_RET_ALREADY_INIT   100

rcl_init() already called return code.

◆ RCL_RET_NOT_INIT

#define RCL_RET_NOT_INIT   101

rcl_init() not yet called return code.

◆ RCL_RET_MISMATCHED_RMW_ID

#define RCL_RET_MISMATCHED_RMW_ID   102

Mismatched rmw identifier return code.

◆ RCL_RET_TOPIC_NAME_INVALID

#define RCL_RET_TOPIC_NAME_INVALID   103

Topic name does not pass validation.

◆ RCL_RET_SERVICE_NAME_INVALID

#define RCL_RET_SERVICE_NAME_INVALID   104

Service name (same as topic name) does not pass validation.

◆ RCL_RET_UNKNOWN_SUBSTITUTION

#define RCL_RET_UNKNOWN_SUBSTITUTION   105

Topic name substitution is unknown.

◆ RCL_RET_ALREADY_SHUTDOWN

#define RCL_RET_ALREADY_SHUTDOWN   106

rcl_shutdown() already called return code.

◆ RCL_RET_NODE_INVALID

#define RCL_RET_NODE_INVALID   200

Invalid rcl_node_t given return code.

◆ RCL_RET_NODE_INVALID_NAME

#define RCL_RET_NODE_INVALID_NAME   201

◆ RCL_RET_NODE_INVALID_NAMESPACE

#define RCL_RET_NODE_INVALID_NAMESPACE   202

◆ RCL_RET_PUBLISHER_INVALID

#define RCL_RET_PUBLISHER_INVALID   300

Invalid rcl_publisher_t given return code.

◆ RCL_RET_SUBSCRIPTION_INVALID

#define RCL_RET_SUBSCRIPTION_INVALID   400

Invalid rcl_subscription_t given return code.

◆ RCL_RET_SUBSCRIPTION_TAKE_FAILED

#define RCL_RET_SUBSCRIPTION_TAKE_FAILED   401

Failed to take a message from the subscription return code.

◆ RCL_RET_CLIENT_INVALID

#define RCL_RET_CLIENT_INVALID   500

Invalid rcl_client_t given return code.

◆ RCL_RET_CLIENT_TAKE_FAILED

#define RCL_RET_CLIENT_TAKE_FAILED   501

Failed to take a response from the client return code.

◆ RCL_RET_SERVICE_INVALID

#define RCL_RET_SERVICE_INVALID   600

Invalid rcl_service_t given return code.

◆ RCL_RET_SERVICE_TAKE_FAILED

#define RCL_RET_SERVICE_TAKE_FAILED   601

Failed to take a request from the service return code.

◆ RCL_RET_TIMER_INVALID

#define RCL_RET_TIMER_INVALID   800

Invalid rcl_timer_t given return code.

◆ RCL_RET_TIMER_CANCELED

#define RCL_RET_TIMER_CANCELED   801

Given timer was canceled return code.

◆ RCL_RET_WAIT_SET_INVALID

#define RCL_RET_WAIT_SET_INVALID   900

Invalid rcl_wait_set_t given return code.

◆ RCL_RET_WAIT_SET_EMPTY

#define RCL_RET_WAIT_SET_EMPTY   901

Given rcl_wait_set_t is empty return code.

◆ RCL_RET_WAIT_SET_FULL

#define RCL_RET_WAIT_SET_FULL   902

Given rcl_wait_set_t is full return code.

◆ RCL_RET_INVALID_REMAP_RULE

#define RCL_RET_INVALID_REMAP_RULE   1001

Argument is not a valid remap rule.

◆ RCL_RET_WRONG_LEXEME

#define RCL_RET_WRONG_LEXEME   1002

Expected one type of lexeme but got another.

◆ RCL_RET_INVALID_PARAM_RULE

#define RCL_RET_INVALID_PARAM_RULE   1010

Argument is not a valid parameter rule.

◆ RCL_RET_INVALID_LOG_LEVEL_RULE

#define RCL_RET_INVALID_LOG_LEVEL_RULE   1020

Argument is not a valid log level rule.

Typedef Documentation

◆ rcl_ret_t

◆ rcl_serialized_message_t

typedef for rmw_serialized_message_t;