iceoryx_binding_c/chunk.h🔗

Functions🔗

	Name
void *	iox_chunk_header_to_user_payload(iox_chunk_header_t *const chunkHeader) gets the user-payload from the chunk-header
const void *	iox_chunk_header_to_user_payload_const(const iox_chunk_header_t *const chunkHeader) gets the const user-payload from the const chunk-header
void *	iox_chunk_header_to_user_header(iox_chunk_header_t *const chunkHeader) gets the user-header from the chunk-header
const void *	iox_chunk_header_to_user_header_const(const iox_chunk_header_t *const chunkHeader) gets the const user-payload from the const chunk-header
iox_chunk_header_t *	iox_chunk_header_from_user_payload(void *const userPayload) gets the chunk-header from the user-payload
const iox_chunk_header_t *	iox_chunk_header_from_user_payload_const(const void *const userPayload) gets the const chunk-header from the const user-payload

Functions Documentation🔗

function iox_chunk_header_to_user_payload🔗

void * iox_chunk_header_to_user_payload(
    iox_chunk_header_t *const chunkHeader
)

gets the user-payload from the chunk-header

Parameters:

chunkHeader pointer to the chunk-header

Return: pointer to the user-payload

function iox_chunk_header_to_user_payload_const🔗

const void * iox_chunk_header_to_user_payload_const(
    const iox_chunk_header_t *const chunkHeader
)

gets the const user-payload from the const chunk-header

Parameters:

chunkHeader const pointer to the chunk-header

Return: const pointer to the user-payload

function iox_chunk_header_to_user_header🔗

void * iox_chunk_header_to_user_header(
    iox_chunk_header_t *const chunkHeader
)

gets the user-header from the chunk-header

Parameters:

chunkHeader pointer to the chunk-header

Return: pointer to the user-header

function iox_chunk_header_to_user_header_const🔗

const void * iox_chunk_header_to_user_header_const(
    const iox_chunk_header_t *const chunkHeader
)

gets the const user-payload from the const chunk-header

Parameters:

chunkHeader const pointer to the chunk-header

Return: const pointer to the user-header

function iox_chunk_header_from_user_payload🔗

iox_chunk_header_t * iox_chunk_header_from_user_payload(
    void *const userPayload
)

gets the chunk-header from the user-payload

Parameters:

userPayload pointer to the user-payload

Return: pointer to the chunk-header

function iox_chunk_header_from_user_payload_const🔗

const iox_chunk_header_t * iox_chunk_header_from_user_payload_const(
    const void *const userPayload
)

gets the const chunk-header from the const user-payload

Parameters:

userPayload const pointer to the user-payload

Return: const pointer to the chunk-header

Source code🔗

// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0

#ifndef IOX_BINDING_C_CHUNK_H
#define IOX_BINDING_C_CHUNK_H

#include "iceoryx_binding_c/types.h"

void* iox_chunk_header_to_user_payload(iox_chunk_header_t* const chunkHeader);

const void* iox_chunk_header_to_user_payload_const(const iox_chunk_header_t* const chunkHeader);

void* iox_chunk_header_to_user_header(iox_chunk_header_t* const chunkHeader);

const void* iox_chunk_header_to_user_header_const(const iox_chunk_header_t* const chunkHeader);

iox_chunk_header_t* iox_chunk_header_from_user_payload(void* const userPayload);

const iox_chunk_header_t* iox_chunk_header_from_user_payload_const(const void* const userPayload);

#endif

Updated on 2 April 2022 at 16:37:47 CEST