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

Go to the source code of this file.

Macros

#define rcl_get_default_allocator   rcutils_get_default_allocator
 Return a properly initialized rcl_allocator_t with default values. More...
 
#define rcl_reallocf   rcutils_reallocf
 Emulate the behavior of reallocf. More...
 
#define RCL_CHECK_ALLOCATOR(allocator, fail_statement)   RCUTILS_CHECK_ALLOCATOR(allocator, fail_statement)
 Check that the given allocator is initialized. More...
 
#define RCL_CHECK_ALLOCATOR_WITH_MSG(allocator, msg, fail_statement)   RCUTILS_CHECK_ALLOCATOR_WITH_MSG(allocator, msg, fail_statement)
 Check that the given allocator is initialized, or fail with a message. More...
 

Typedefs

typedef rcutils_allocator_t rcl_allocator_t
 Encapsulation of an allocator. More...
 

Macro Definition Documentation

◆ rcl_get_default_allocator

#define rcl_get_default_allocator   rcutils_get_default_allocator

Return a properly initialized rcl_allocator_t with default values.

See also
rcutils_get_default_allocator()

◆ rcl_reallocf

#define rcl_reallocf   rcutils_reallocf

Emulate the behavior of reallocf.

See also
rcutils_reallocf()

◆ RCL_CHECK_ALLOCATOR

#define RCL_CHECK_ALLOCATOR (   allocator,
  fail_statement 
)    RCUTILS_CHECK_ALLOCATOR(allocator, fail_statement)

Check that the given allocator is initialized.

If the allocator is not initialized, run the fail_statement.

◆ RCL_CHECK_ALLOCATOR_WITH_MSG

#define RCL_CHECK_ALLOCATOR_WITH_MSG (   allocator,
  msg,
  fail_statement 
)    RCUTILS_CHECK_ALLOCATOR_WITH_MSG(allocator, msg, fail_statement)

Check that the given allocator is initialized, or fail with a message.

If the allocator is not initialized, set the error to msg, and run the fail_statement.

Typedef Documentation

◆ rcl_allocator_t

Encapsulation of an allocator.

See also
rcutils_allocator_t