iceoryx_binding_c/notification_info.h🔗

Types🔗

	Name
typedef const CLASS NotificationInfo *	iox_notification_info_t notification info handle

Functions🔗

	Name
uint64_t	iox_notification_info_get_notification_id(iox_notification_info_t const self) returns the id of the notification
bool	iox_notification_info_does_originate_from_subscriber(iox_notification_info_t const self, iox_sub_t const subscriber) does the notification originate from a certain subscriber
bool	iox_notification_info_does_originate_from_user_trigger(iox_notification_info_t const self, iox_user_trigger_t const user_trigger) does the notification originate from a certain user trigger
bool	iox_notification_info_does_originate_from_client(iox_notification_info_t const self, iox_client_t const client) does the notification originate from a certain client
bool	iox_notification_info_does_originate_from_server(iox_notification_info_t const self, iox_server_t const server) does the notification originate from a certain server
bool	iox_notification_info_does_originate_from_service_discovery(iox_notification_info_t const self, iox_service_discovery_t const serviceDiscovery) does the notification originate from a certain service discovery
iox_sub_t	iox_notification_info_get_subscriber_origin(iox_notification_info_t const self) acquires the handle of the subscriber origin
iox_user_trigger_t	iox_notification_info_get_user_trigger_origin(iox_notification_info_t const self) acquires the handle of the user trigger origin
iox_client_t	iox_notification_info_get_client_origin(iox_notification_info_t const self) acquires the handle of the client origin
iox_server_t	iox_notification_info_get_server_origin(iox_notification_info_t const self) acquires the handle of the server origin
iox_service_discovery_t	iox_notification_info_get_service_discovery_origin(iox_notification_info_t const self) acquires the handle of the service discovery origin
void	iox_notification_info_call(iox_notification_info_t const self) calls the callback of the notification

Types Documentation🔗

typedef iox_notification_info_t🔗

typedef const CLASS NotificationInfo* iox_notification_info_t;

notification info handle

Functions Documentation🔗

function iox_notification_info_get_notification_id🔗

uint64_t iox_notification_info_get_notification_id(
    iox_notification_info_t const self
)

returns the id of the notification

Parameters:

self handle to notification info

Return: notificationId

function iox_notification_info_does_originate_from_subscriber🔗

bool iox_notification_info_does_originate_from_subscriber(
    iox_notification_info_t const self,
    iox_sub_t const subscriber
)

does the notification originate from a certain subscriber

Parameters:

self handle to notification info
subscriber handle to the subscriber in question

Return: true if the notification originates from the subscriber, otherwise false

function iox_notification_info_does_originate_from_user_trigger🔗

bool iox_notification_info_does_originate_from_user_trigger(
    iox_notification_info_t const self,
    iox_user_trigger_t const user_trigger
)

does the notification originate from a certain user trigger

Parameters:

self handle to notification info
user_trigger handle to the user trigger in question

Return: true if the notification originates from the user trigger, otherwise false

function iox_notification_info_does_originate_from_client🔗

bool iox_notification_info_does_originate_from_client(
    iox_notification_info_t const self,
    iox_client_t const client
)

does the notification originate from a certain client

Parameters:

self handle to notification info
client handle to the client in question

Return: true if the notification originates from the client, otherwise false

function iox_notification_info_does_originate_from_server🔗

bool iox_notification_info_does_originate_from_server(
    iox_notification_info_t const self,
    iox_server_t const server
)

does the notification originate from a certain server

Parameters:

self handle to notification info
server handle to the server in question

Return: true if the notification originates from the server, otherwise false

function iox_notification_info_does_originate_from_service_discovery🔗

bool iox_notification_info_does_originate_from_service_discovery(
    iox_notification_info_t const self,
    iox_service_discovery_t const serviceDiscovery
)

does the notification originate from a certain service discovery

Parameters:

self handle to notification info
serviceDiscovery handle to serviceDiscovery in question

Return: true if the notifiaction originates from the service discovery, otherwise false

function iox_notification_info_get_subscriber_origin🔗

iox_sub_t iox_notification_info_get_subscriber_origin(
    iox_notification_info_t const self
)

acquires the handle of the subscriber origin

Parameters:

self handle to notification info

Return: the handle to the subscriber if the notification originated from a subscriber, otherwise NULL

function iox_notification_info_get_user_trigger_origin🔗

iox_user_trigger_t iox_notification_info_get_user_trigger_origin(
    iox_notification_info_t const self
)

acquires the handle of the user trigger origin

Parameters:

self handle to notification info

Return: the handle to the user trigger if the notification originated from a user trigger, otherwise NULL

function iox_notification_info_get_client_origin🔗

iox_client_t iox_notification_info_get_client_origin(
    iox_notification_info_t const self
)

acquires the handle of the client origin

Parameters:

self handle to notification info

Return: the handle to the client if the notification originated from a client, otherwise NULL

function iox_notification_info_get_server_origin🔗

iox_server_t iox_notification_info_get_server_origin(
    iox_notification_info_t const self
)

acquires the handle of the server origin

Parameters:

self handle to notification info

Return: the handle to the server if the notification originated from a server, otherwise NULL

function iox_notification_info_get_service_discovery_origin🔗

iox_service_discovery_t iox_notification_info_get_service_discovery_origin(
    iox_notification_info_t const self
)

acquires the handle of the service discovery origin

Parameters:

self handle to the notification info

Return: the handle to the service discovery if the notification originated from a service discovery, otherwise NULL

function iox_notification_info_call🔗

void iox_notification_info_call(
    iox_notification_info_t const self
)

calls the callback of the notification

Parameters:

self handle to notification info

Source code🔗

// Copyright (c) 2020 - 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_EVENT_INFO_H
#define IOX_BINDING_C_EVENT_INFO_H

#include "iceoryx_binding_c/client.h"
#include "iceoryx_binding_c/internal/c2cpp_binding.h"
#include "iceoryx_binding_c/server.h"
#include "iceoryx_binding_c/service_discovery.h"
#include "iceoryx_binding_c/subscriber.h"
#include "iceoryx_binding_c/user_trigger.h"

typedef const CLASS NotificationInfo* iox_notification_info_t;

uint64_t iox_notification_info_get_notification_id(iox_notification_info_t const self);

bool iox_notification_info_does_originate_from_subscriber(iox_notification_info_t const self,
                                                          iox_sub_t const subscriber);

bool iox_notification_info_does_originate_from_user_trigger(iox_notification_info_t const self,
                                                            iox_user_trigger_t const user_trigger);

bool iox_notification_info_does_originate_from_client(iox_notification_info_t const self, iox_client_t const client);

bool iox_notification_info_does_originate_from_server(iox_notification_info_t const self, iox_server_t const server);

bool iox_notification_info_does_originate_from_service_discovery(iox_notification_info_t const self,
                                                                 iox_service_discovery_t const serviceDiscovery);

iox_sub_t iox_notification_info_get_subscriber_origin(iox_notification_info_t const self);

iox_user_trigger_t iox_notification_info_get_user_trigger_origin(iox_notification_info_t const self);

iox_client_t iox_notification_info_get_client_origin(iox_notification_info_t const self);

iox_server_t iox_notification_info_get_server_origin(iox_notification_info_t const self);

iox_service_discovery_t iox_notification_info_get_service_discovery_origin(iox_notification_info_t const self);

void iox_notification_info_call(iox_notification_info_t const self);

#endif

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