iceoryx_binding_c/request_header.h🔗

Types🔗

	Name
typedef CLASS RequestHeader *	iox_request_header_t request header handle

Functions🔗

	Name
iox_request_header_t	iox_request_header_from_payload(void *const payload) extract the request header from a given payload
iox_const_request_header_t	iox_request_header_from_payload_const(const void *const payload) extract the request header from a given payload
void	iox_request_header_set_sequence_id(iox_request_header_t const self, const int64_t sequenceId) set the sequence id of the request header
uint8_t	iox_request_header_get_rpc_header_version(iox_request_header_t const self) returns the rpc header version
uint8_t	iox_request_header_get_rpc_header_version_const(iox_const_request_header_t const self) returns the rpc header version
int64_t	iox_request_header_get_sequence_id(iox_request_header_t const self) returns the sequence id
int64_t	iox_request_header_get_sequence_id_const(iox_const_request_header_t const self) returns the sequence id
void *	iox_request_header_get_user_payload(iox_request_header_t const self) returns a pointer to the user payload
const void *	iox_request_header_get_user_payload_const(iox_const_request_header_t const self) returns a pointer to the user payload
iox_chunk_header_t *	iox_request_header_get_chunk_header(iox_request_header_t const self) returns a pointer to the chunk header
const iox_chunk_header_t *	iox_request_header_get_chunk_header_const(iox_const_request_header_t const self) returns a pointer to the chunk header

Attributes🔗

	Name
const typedef CLASS RequestHeader *	iox_const_request_header_t const request header handle

Types Documentation🔗

typedef iox_request_header_t🔗

typedef CLASS RequestHeader* iox_request_header_t;

request header handle

Functions Documentation🔗

function iox_request_header_from_payload🔗

iox_request_header_t iox_request_header_from_payload(
    void *const payload
)

extract the request header from a given payload

Parameters:

payload the pointer to the payload

Return: a handle to the request header

function iox_request_header_from_payload_const🔗

iox_const_request_header_t iox_request_header_from_payload_const(
    const void *const payload
)

extract the request header from a given payload

Parameters:

payload the pointer to the payload

Return: a handle to the request header

function iox_request_header_set_sequence_id🔗

void iox_request_header_set_sequence_id(
    iox_request_header_t const self,
    const int64_t sequenceId
)

set the sequence id of the request header

Parameters:

self handle to the request header
sequenceId the new sequence id value

function iox_request_header_get_rpc_header_version🔗

uint8_t iox_request_header_get_rpc_header_version(
    iox_request_header_t const self
)

returns the rpc header version

Parameters:

self handle to the request header

Return: rpc header version

function iox_request_header_get_rpc_header_version_const🔗

uint8_t iox_request_header_get_rpc_header_version_const(
    iox_const_request_header_t const self
)

returns the rpc header version

Parameters:

self handle to the request header

Return: rpc header version

function iox_request_header_get_sequence_id🔗

int64_t iox_request_header_get_sequence_id(
    iox_request_header_t const self
)

returns the sequence id

Parameters:

self handle to the request header

Return: sequence id

function iox_request_header_get_sequence_id_const🔗

int64_t iox_request_header_get_sequence_id_const(
    iox_const_request_header_t const self
)

returns the sequence id

Parameters:

self handle to the request header

Return: sequence id

function iox_request_header_get_user_payload🔗

void * iox_request_header_get_user_payload(
    iox_request_header_t const self
)

returns a pointer to the user payload

Parameters:

self handle to the request header

Return: pointer to the payload

function iox_request_header_get_user_payload_const🔗

const void * iox_request_header_get_user_payload_const(
    iox_const_request_header_t const self
)

returns a pointer to the user payload

Parameters:

self handle to the request header

Return: pointer to the payload

function iox_request_header_get_chunk_header🔗

iox_chunk_header_t * iox_request_header_get_chunk_header(
    iox_request_header_t const self
)

returns a pointer to the chunk header

Parameters:

self handle to the request header

Return: pointer to the chunk header

function iox_request_header_get_chunk_header_const🔗

const iox_chunk_header_t * iox_request_header_get_chunk_header_const(
    iox_const_request_header_t const self
)

returns a pointer to the chunk header

Parameters:

self handle to the request header

Return: pointer to the chunk header

Attributes Documentation🔗

variable iox_const_request_header_t🔗

const typedef CLASS RequestHeader * iox_const_request_header_t;

const request header handle

Source code🔗

// Copyright (c) 2022 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_REQUEST_HEADER_H
#define IOX_BINDING_C_REQUEST_HEADER_H

#include "iceoryx_binding_c/chunk.h"
#include "iceoryx_binding_c/internal/c2cpp_binding.h"

typedef CLASS RequestHeader* iox_request_header_t;

typedef const CLASS RequestHeader* iox_const_request_header_t;

iox_request_header_t iox_request_header_from_payload(void* const payload);

iox_const_request_header_t iox_request_header_from_payload_const(const void* const payload);

void iox_request_header_set_sequence_id(iox_request_header_t const self, const int64_t sequenceId);

uint8_t iox_request_header_get_rpc_header_version(iox_request_header_t const self);

uint8_t iox_request_header_get_rpc_header_version_const(iox_const_request_header_t const self);

int64_t iox_request_header_get_sequence_id(iox_request_header_t const self);

int64_t iox_request_header_get_sequence_id_const(iox_const_request_header_t const self);

void* iox_request_header_get_user_payload(iox_request_header_t const self);

const void* iox_request_header_get_user_payload_const(iox_const_request_header_t const self);

iox_chunk_header_t* iox_request_header_get_chunk_header(iox_request_header_t const self);

const iox_chunk_header_t* iox_request_header_get_chunk_header_const(iox_const_request_header_t const self);

#endif

Updated on 18 December 2023 at 13:02:35 CET