ROS 2 rclcpp + rcl - jazzy  jazzy
ROS 2 C++ Client Library with ROS Client Library
Functions | Variables
localhost.h File Reference
#include "rcl/types.h"
#include "rcl/visibility_control.h"
#include "rmw/localhost.h"
Include dependency graph for localhost.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

RCL_PUBLIC rcl_ret_t rcl_get_localhost_only (rmw_localhost_only_t *localhost_only)
 Determine if the user wants to communicate using loopback only. More...
 

Variables

const char *const RCL_LOCALHOST_ENV_VAR
 

Function Documentation

◆ rcl_get_localhost_only()

RCL_PUBLIC rcl_ret_t rcl_get_localhost_only ( rmw_localhost_only_t *  localhost_only)

Determine if the user wants to communicate using loopback only.

Checks if localhost should be used for network communication based on environment.

Parameters
[out]localhost_onlyMust not be NULL.
Returns
RCL_RET_INVALID_ARGUMENT if an argument is invalid, or
RCL_RET_ERROR if an unexpected error happened, or
RCL_RET_OK.

Definition at line 28 of file localhost.c.

References RCL_RET_ERROR, and RCL_RET_INVALID_ARGUMENT.

Referenced by rcl_init().

Here is the caller graph for this function: