init_options.h

Go to the documentation of this file.

// Copyright 2014-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 RMW__INIT_OPTIONS_H_
#define RMW__INIT_OPTIONS_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
 
#include "rcutils/allocator.h"
#include "rmw/domain_id.h"
#include "rmw/localhost.h"
#include "rmw/macros.h"
#include "rmw/ret_types.h"
#include "rmw/security_options.h"
#include "rmw/visibility_control.h"
 
 
typedef struct rmw_init_options_impl_t rmw_init_options_impl_t;
 
typedef struct RMW_PUBLIC_TYPE rmw_init_options_t
{
 
  uint64_t instance_id;
  const char * implementation_identifier;
  size_t domain_id;
  rmw_security_options_t security_options;
  rmw_localhost_only_t localhost_only;
  char * enclave;
 
  // TODO(wjwwood): replace with rmw_allocator_t when that refactor happens
  rcutils_allocator_t allocator;
 
  rmw_init_options_impl_t * impl;
} rmw_init_options_t;
 
RMW_PUBLIC
RMW_WARN_UNUSED
rmw_init_options_t
rmw_get_zero_initialized_init_options(void);
 
 
RMW_PUBLIC
RMW_WARN_UNUSED
rmw_ret_t
rmw_init_options_init(rmw_init_options_t * init_options, rcutils_allocator_t allocator);
 
 
RMW_PUBLIC
RMW_WARN_UNUSED
rmw_ret_t
rmw_init_options_copy(const rmw_init_options_t * src, rmw_init_options_t * dst);
 
 
RMW_PUBLIC
RMW_WARN_UNUSED
rmw_ret_t
rmw_init_options_fini(rmw_init_options_t * init_options);
 
#ifdef __cplusplus
}
#endif
 
#endif  // RMW__INIT_OPTIONS_H_