localhost.h File Reference

#include "rcl/types.h"
#include "rcl/visibility_control.h"
#include "rmw/localhost.h"

Include dependency graph for localhost.h:

Go to the source code of this file.

Functions
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_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_only

Must 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.