iceoryx_binding_c/service_discovery.h🔗

Types🔗

	Name
typedef CLASS ServiceDiscovery *	iox_service_discovery_t service discovery handle

Functions🔗

	Name
iox_service_discovery_t	iox_service_discovery_init(iox_service_discovery_storage_t * self) initializes a service discovery from a storage struct pointer
void	iox_service_discovery_deinit(iox_service_discovery_t const self) after using an iox_service_discovery_t it must be cleaned up with this function
uint64_t	iox_service_discovery_find_service(iox_service_discovery_t const self, const char const service, const char const instance, const char const event, iox_service_description_t const serviceContainer, const uint64_t serviceContainerCapacity, uint64_t * missedServices, const ENUM iox_MessagingPattern pattern) Searches all services with the given messaging pattern that match the provided service description.
void	iox_service_discovery_find_service_apply_callable(iox_service_discovery_t const self, const char const service, const char const instance, const char const event, void()(const iox_service_description_t) callable, const ENUM iox_MessagingPattern pattern) Searches all services with the given messaging pattern that match the provided service description and applies a function to each of them.
void	iox_service_discovery_find_service_apply_callable_with_context_data(iox_service_discovery_t const self, const char const service, const char const instance, const char const event, void()(const iox_service_description_t, void ) callable, void const contextData, const ENUM iox_MessagingPattern pattern) Searches all services with the given messaging pattern that match the provided service description and applies a function to each of them. A second parameter for the function can be provided as contextData.

Types Documentation🔗

typedef iox_service_discovery_t🔗

typedef CLASS ServiceDiscovery* iox_service_discovery_t;

service discovery handle

Functions Documentation🔗

function iox_service_discovery_init🔗

iox_service_discovery_t iox_service_discovery_init(
    iox_service_discovery_storage_t * self
)

initializes a service discovery from a storage struct pointer

Parameters:

self pointer to raw memory which can hold a service discovery

Return: an initialized iox_service_discovery_t

function iox_service_discovery_deinit🔗

void iox_service_discovery_deinit(
    iox_service_discovery_t const self
)

after using an iox_service_discovery_t it must be cleaned up with this function

Parameters:

self the service discovery which should be deinitialized

function iox_service_discovery_find_service🔗

uint64_t iox_service_discovery_find_service(
    iox_service_discovery_t const self,
    const char *const service,
    const char *const instance,
    const char *const event,
    iox_service_description_t *const serviceContainer,
    const uint64_t serviceContainerCapacity,
    uint64_t * missedServices,
    const ENUM iox_MessagingPattern pattern
)

Searches all services with the given messaging pattern that match the provided service description.

Parameters:

self handle of the service discovery
service service string to search for, a nullptr corresponds to a wildcard
instance instance string to search for, a nullptr corresponds to a wildcard
event event string to search for, a nullptr corresponds to a wildcard
serviceContainer preallocated memory to an array of iox_service_description_t in which the matching services can be written
serviceContainerCapacity the capacity of the preallocated serviceContainer
missedServices if the serviceContainer has insufficient size the number of missed services which could not be written into the serviceContainer are stored here
pattern messaging pattern of the service to search

Return: the number of services which were written into the serviceContainer

function iox_service_discovery_find_service_apply_callable🔗

void iox_service_discovery_find_service_apply_callable(
    iox_service_discovery_t const self,
    const char *const service,
    const char *const instance,
    const char *const event,
    void(*)(const iox_service_description_t) callable,
    const ENUM iox_MessagingPattern pattern
)

Searches all services with the given messaging pattern that match the provided service description and applies a function to each of them.

Parameters:

self handle of the service discovery
service service string to search for, a nullptr corresponds to a wildcard
instance instance string to search for, a nullptr corresponds to a wildcard
event event string to search for, a nullptr corresponds to a wildcard
callable to apply to all matching services
pattern messaging pattern of the service to search

function iox_service_discovery_find_service_apply_callable_with_context_data🔗

void iox_service_discovery_find_service_apply_callable_with_context_data(
    iox_service_discovery_t const self,
    const char *const service,
    const char *const instance,
    const char *const event,
    void(*)(const iox_service_description_t, void *) callable,
    void *const contextData,
    const ENUM iox_MessagingPattern pattern
)

Searches all services with the given messaging pattern that match the provided service description and applies a function to each of them. A second parameter for the function can be provided as contextData.

Parameters:

self handle of the service discovery
service service string to search for, a nullptr corresponds to a wildcard
instance instance string to search for, a nullptr corresponds to a wildcard
event event string to search for, a nullptr corresponds to a wildcard
callable to apply to all matching services
contextData a void pointer which is provided as second argument to the callback
pattern messaging pattern of the service to search

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_SERVICE_DISCOVERY_H
#define IOX_BINDING_C_SERVICE_DISCOVERY_H

#include "iceoryx_binding_c/enums.h"
#include "iceoryx_binding_c/internal/c2cpp_binding.h"
#include "iceoryx_binding_c/types.h"
#include "service_description.h"

typedef CLASS ServiceDiscovery* iox_service_discovery_t;

iox_service_discovery_t iox_service_discovery_init(iox_service_discovery_storage_t* self);

void iox_service_discovery_deinit(iox_service_discovery_t const self);

uint64_t iox_service_discovery_find_service(iox_service_discovery_t const self,
                                            const char* const service,
                                            const char* const instance,
                                            const char* const event,
                                            iox_service_description_t* const serviceContainer,
                                            const uint64_t serviceContainerCapacity,
                                            uint64_t* missedServices,
                                            const ENUM iox_MessagingPattern pattern);

void iox_service_discovery_find_service_apply_callable(iox_service_discovery_t const self,
                                                       const char* const service,
                                                       const char* const instance,
                                                       const char* const event,
                                                       void (*callable)(const iox_service_description_t),
                                                       const ENUM iox_MessagingPattern pattern);

void iox_service_discovery_find_service_apply_callable_with_context_data(
    iox_service_discovery_t const self,
    const char* const service,
    const char* const instance,
    const char* const event,
    void (*callable)(const iox_service_description_t, void*),
    void* const contextData,
    const ENUM iox_MessagingPattern pattern);

#endif

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