Program Listing for File init_options.h

↰ Return to documentation for file (include/rcl/init_options.h)

// Copyright 2018 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


#ifndef RCL__INIT_OPTIONS_H_
#define RCL__INIT_OPTIONS_H_

#ifdef __cplusplus
extern "C"
{
#endif

#include "rmw/init.h"

#include "rcl/allocator.h"
#include "rcl/macros.h"
#include "rcl/types.h"
#include "rcl/visibility_control.h"

typedef struct rcl_init_options_impl_s rcl_init_options_impl_t;

typedef struct rcl_init_options_s
{
  rcl_init_options_impl_t * impl;
} rcl_init_options_t;

RCL_PUBLIC
RCL_WARN_UNUSED
rcl_init_options_t
rcl_get_zero_initialized_init_options(void);


RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_init(rcl_init_options_t * init_options, rcl_allocator_t allocator);


RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_copy(const rcl_init_options_t * src, rcl_init_options_t * dst);


RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_fini(rcl_init_options_t * init_options);


RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_get_domain_id(const rcl_init_options_t * init_options, size_t * domain_id);


RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_set_domain_id(rcl_init_options_t * init_options, size_t domain_id);


RCL_PUBLIC
RCL_WARN_UNUSED
rmw_init_options_t *
rcl_init_options_get_rmw_init_options(rcl_init_options_t * init_options);


RCL_PUBLIC
RCL_WARN_UNUSED
const rcl_allocator_t *
rcl_init_options_get_allocator(const rcl_init_options_t * init_options);

#ifdef __cplusplus
}
#endif

#endif  // RCL__INIT_OPTIONS_H_