iceoryx_binding_c/response_header.h🔗

Types🔗

	Name
typedef CLASS ResponseHeader *	iox_response_header_t response header handle
typedef const CLASS ResponseHeader *	iox_const_response_header_t const response header handle

Functions🔗

	Name
iox_response_header_t	iox_response_header_from_payload(void *const payload) extract the response header from a given payload
iox_const_response_header_t	iox_response_header_from_payload_const(const void *const payload) extract the response header from a given payload
void	iox_response_header_set_server_error(iox_response_header_t const self) set the response header into server error state
bool	iox_response_header_has_server_error(iox_response_header_t const self) is the response header in an error state
bool	iox_response_header_has_server_error_const(iox_const_response_header_t const self) is the response header in an error state
uint8_t	iox_response_header_get_rpc_header_version(iox_response_header_t const self) returns the rpc header version
uint8_t	iox_response_header_get_rpc_header_version_const(iox_const_response_header_t const self) returns the rpc header version
int64_t	iox_response_header_get_sequence_id(iox_response_header_t const self) returns the sequence id
int64_t	iox_response_header_get_sequence_id_const(iox_const_response_header_t const self) returns the sequence id
void *	iox_response_header_get_user_payload(iox_response_header_t const self) returns a pointer to the user payload
const void *	iox_response_header_get_user_payload_const(iox_const_response_header_t const self) returns a pointer to the user payload
iox_chunk_header_t *	iox_response_header_get_chunk_header(iox_response_header_t const self) returns a pointer to the chunk header
const iox_chunk_header_t *	iox_response_header_get_chunk_header_const(iox_const_response_header_t const self) returns a pointer to the chunk header

Types Documentation🔗

typedef iox_response_header_t🔗

typedef CLASS ResponseHeader* iox_response_header_t;

response header handle

typedef iox_const_response_header_t🔗

typedef const CLASS ResponseHeader* iox_const_response_header_t;

const response header handle

Functions Documentation🔗

function iox_response_header_from_payload🔗

iox_response_header_t iox_response_header_from_payload(
    void *const payload
)

extract the response header from a given payload

Parameters:

payload the pointer to the payload

Return: a handle to the response header

function iox_response_header_from_payload_const🔗

iox_const_response_header_t iox_response_header_from_payload_const(
    const void *const payload
)

extract the response header from a given payload

Parameters:

payload the pointer to the payload

Return: a handle to the response header

function iox_response_header_set_server_error🔗

void iox_response_header_set_server_error(
    iox_response_header_t const self
)

set the response header into server error state

Parameters:

self handle to the response header

function iox_response_header_has_server_error🔗

bool iox_response_header_has_server_error(
    iox_response_header_t const self
)

is the response header in an error state

Parameters:

self handle to the response header

Return: true if it is in an error state, otherwise false

function iox_response_header_has_server_error_const🔗

bool iox_response_header_has_server_error_const(
    iox_const_response_header_t const self
)

is the response header in an error state

Parameters:

self handle to the response header

Return: true if it is in an error state, otherwise false

function iox_response_header_get_rpc_header_version🔗

uint8_t iox_response_header_get_rpc_header_version(
    iox_response_header_t const self
)

returns the rpc header version

Parameters:

self handle to the response header

Return: rpc header version

function iox_response_header_get_rpc_header_version_const🔗

uint8_t iox_response_header_get_rpc_header_version_const(
    iox_const_response_header_t const self
)

returns the rpc header version

Parameters:

self handle to the response header

Return: rpc header version

function iox_response_header_get_sequence_id🔗

int64_t iox_response_header_get_sequence_id(
    iox_response_header_t const self
)

returns the sequence id

Parameters:

self handle to the response header

Return: sequence id

function iox_response_header_get_sequence_id_const🔗

int64_t iox_response_header_get_sequence_id_const(
    iox_const_response_header_t const self
)

returns the sequence id

Parameters:

self handle to the response header

Return: sequence id

function iox_response_header_get_user_payload🔗

void * iox_response_header_get_user_payload(
    iox_response_header_t const self
)

returns a pointer to the user payload

Parameters:

self handle to the response header

Return: pointer to the payload

function iox_response_header_get_user_payload_const🔗

const void * iox_response_header_get_user_payload_const(
    iox_const_response_header_t const self
)

returns a pointer to the user payload

Parameters:

self handle to the response header

Return: pointer to the payload

function iox_response_header_get_chunk_header🔗

iox_chunk_header_t * iox_response_header_get_chunk_header(
    iox_response_header_t const self
)

returns a pointer to the chunk header

Parameters:

self handle to the response header

Return: pointer to the chunk header

function iox_response_header_get_chunk_header_const🔗

const iox_chunk_header_t * iox_response_header_get_chunk_header_const(
    iox_const_response_header_t const self
)

returns a pointer to the chunk header

Parameters:

self handle to the response header

Return: pointer to the chunk header

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_RESPONSE_HEADER_H
#define IOX_BINDING_C_RESPONSE_HEADER_H

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

typedef CLASS ResponseHeader* iox_response_header_t;

typedef const CLASS ResponseHeader* iox_const_response_header_t;

iox_response_header_t iox_response_header_from_payload(void* const payload);

iox_const_response_header_t iox_response_header_from_payload_const(const void* const payload);

void iox_response_header_set_server_error(iox_response_header_t const self);

bool iox_response_header_has_server_error(iox_response_header_t const self);

bool iox_response_header_has_server_error_const(iox_const_response_header_t const self);

uint8_t iox_response_header_get_rpc_header_version(iox_response_header_t const self);

uint8_t iox_response_header_get_rpc_header_version_const(iox_const_response_header_t const self);

int64_t iox_response_header_get_sequence_id(iox_response_header_t const self);

int64_t iox_response_header_get_sequence_id_const(iox_const_response_header_t const self);

void* iox_response_header_get_user_payload(iox_response_header_t const self);

const void* iox_response_header_get_user_payload_const(iox_const_response_header_t const self);

iox_chunk_header_t* iox_response_header_get_chunk_header(iox_response_header_t const self);

const iox_chunk_header_t* iox_response_header_get_chunk_header_const(iox_const_response_header_t const self);

#endif

Updated on 31 May 2022 at 11:34:55 CEST