network_flow_endpoint_array.h File Reference

#include "rcutils/allocator.h"
#include "rmw/network_flow_endpoint.h"
#include "rmw/types.h"
#include "rmw/visibility_control.h"

Include dependency graph for network_flow_endpoint_array.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	rmw_network_flow_endpoint_array_t
	Structure to hold an arrary of network_flow_endpoint_t. More...

Typedefs
typedef struct RMW_PUBLIC_TYPE rmw_network_flow_endpoint_array_t	rmw_network_flow_endpoint_array_t
	Structure to hold an arrary of network_flow_endpoint_t. More...

Functions
rmw_network_flow_endpoint_array_t	rmw_get_zero_initialized_network_flow_endpoint_array (void)
	Return a rmw_network_flow_endpoint_array_t instance with zero-initialized members. More...
rmw_ret_t	rmw_network_flow_endpoint_array_check_zero (const rmw_network_flow_endpoint_array_t *network_flow_endpoint_array)
	Check if network_flow_endpoint_array instance is zero-initialized. More...
rmw_ret_t	rmw_network_flow_endpoint_array_init (rmw_network_flow_endpoint_array_t *network_flow_endpoint_array, size_t size, rcutils_allocator_t *allocator)
	Allocate a rmw_network_flow_endpoint_array_t instance. More...
rmw_ret_t	rmw_network_flow_endpoint_array_fini (rmw_network_flow_endpoint_array_t *network_flow_endpoint_array)
	Deallocate a rmw_network_flow_endpoint_array_t instance. More...

Typedef Documentation

rmw_network_flow_endpoint_array_t

typedef struct RMW_PUBLIC_TYPE rmw_network_flow_endpoint_array_t rmw_network_flow_endpoint_array_t

Structure to hold an arrary of network_flow_endpoint_t.

Function Documentation

rmw_get_zero_initialized_network_flow_endpoint_array()

rmw_network_flow_endpoint_array_t rmw_get_zero_initialized_network_flow_endpoint_array

(

void

)

Return a rmw_network_flow_endpoint_array_t instance with zero-initialized members.

rmw_network_flow_endpoint_array_check_zero()

rmw_ret_t rmw_network_flow_endpoint_array_check_zero

(

const rmw_network_flow_endpoint_array_t *

network_flow_endpoint_array

)

Check if network_flow_endpoint_array instance is zero-initialized.

Parameters

[in]

network_flow_endpoint_array

arrary to be checked

Returns

RMW_RET_OK if array is zero-initialized, or

RMW_RET_INVALID_ARGUMENT if network_flow_endpoint_array is NULL, or

RMW_RET_ERROR if network_flow_endpoint_array is not zero-initialized.

Remarks

RMW error state is set on failure

rmw_network_flow_endpoint_array_init()

rmw_ret_t rmw_network_flow_endpoint_array_init	(	rmw_network_flow_endpoint_array_t *	network_flow_endpoint_array,
		size_t	size,
		rcutils_allocator_t *	allocator
	)

Allocate a rmw_network_flow_endpoint_array_t instance.

Parameters

[in,out]	network_flow_endpoint_array	array to be allocated
[in]	size	size of the array to be allocated
[in]	allocator	the allcator for allocating memory

Returns

RMW_RET_OK on successfull initilization, or

RMW_RET_INVALID_ARGUMENT if network_flow_endpoint_array or allocator is NULL, or

RMW_RET_BAD_ALLOC if memory allocation fails, or

RMW_RET_ERROR when an unspecified error occurs.

Remarks

RMW error state is set on failure

rmw_network_flow_endpoint_array_fini()

rmw_ret_t rmw_network_flow_endpoint_array_fini

(

rmw_network_flow_endpoint_array_t *

network_flow_endpoint_array

)

Deallocate a rmw_network_flow_endpoint_array_t instance.

Parameters

[in,out]

network_flow_endpoint_array

array to be deallocated

Returns

RMW_RET_OK on successfully deallocation, or

RMW_RET_INVALID_ARGUMENT if network_flow_endpoint_array or its allocator is NULL, or

RMW_RET_ERROR when an unspecified error occurs.

Remarks

RMW error state is set on failure