106 lines
3.1 KiB
C
106 lines
3.1 KiB
C
// Copyright(c) 2006 to 2022 ZettaScale Technology and others
|
|
//
|
|
// This program and the accompanying materials are made available under the
|
|
// terms of the Eclipse Public License v. 2.0 which is available at
|
|
// http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
|
|
// v. 1.0 which is available at
|
|
// http://www.eclipse.org/org/documents/edl-v10.php.
|
|
//
|
|
// SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
|
|
|
|
#ifndef DDSI_ENTITY_H
|
|
#define DDSI_ENTITY_H
|
|
|
|
#include "dds/export.h"
|
|
#include "dds/features.h"
|
|
|
|
#include "dds/ddsrt/atomics.h"
|
|
#include "dds/ddsrt/avl.h"
|
|
#include "dds/ddsrt/sync.h"
|
|
#include "dds/ddsi/ddsi_protocol.h"
|
|
#include "dds/ddsi/ddsi_guid.h"
|
|
|
|
#if defined (__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct ddsi_rsample_info;
|
|
struct ddsi_rdata;
|
|
struct ddsi_tkmap_instance;
|
|
struct ddsi_local_reader_ary;
|
|
|
|
enum ddsi_entity_kind {
|
|
DDSI_EK_PARTICIPANT,
|
|
DDSI_EK_PROXY_PARTICIPANT,
|
|
DDSI_EK_TOPIC,
|
|
DDSI_EK_WRITER,
|
|
DDSI_EK_PROXY_WRITER,
|
|
DDSI_EK_READER,
|
|
DDSI_EK_PROXY_READER
|
|
};
|
|
|
|
typedef struct ddsi_status_cb_data
|
|
{
|
|
int raw_status_id;
|
|
uint32_t extra;
|
|
uint64_t handle;
|
|
bool add;
|
|
} ddsi_status_cb_data_t;
|
|
|
|
typedef void (*ddsi_status_cb_t) (void *entity, const ddsi_status_cb_data_t *data);
|
|
|
|
typedef struct ddsi_type_pair
|
|
#ifdef DDS_HAS_TYPELIB
|
|
{
|
|
struct ddsi_type *minimal;
|
|
struct ddsi_type *complete;
|
|
}
|
|
#endif
|
|
ddsi_type_pair_t;
|
|
|
|
struct ddsi_entity_common {
|
|
enum ddsi_entity_kind kind;
|
|
ddsi_guid_t guid;
|
|
ddsrt_wctime_t tupdate; /* timestamp of last update */
|
|
uint64_t iid;
|
|
struct ddsi_tkmap_instance *tk;
|
|
ddsrt_mutex_t lock;
|
|
bool onlylocal;
|
|
struct ddsi_domaingv *gv;
|
|
ddsrt_avl_node_t all_entities_avlnode;
|
|
|
|
/* QoS changes always lock the entity itself, and additionally
|
|
(and within the scope of the entity lock) acquire qos_lock
|
|
while manipulating the QoS. So any thread that needs to read
|
|
the QoS without acquiring the entity's lock can still do so
|
|
(e.g., the materialisation of samples for built-in topics
|
|
when connecting a reader to a writer for a built-in topic).
|
|
|
|
qos_lock lock order across entities in is in increasing
|
|
order of entity addresses cast to uintptr_t. */
|
|
ddsrt_mutex_t qos_lock;
|
|
};
|
|
|
|
struct ddsi_local_reader_ary {
|
|
ddsrt_mutex_t rdary_lock; /* mutations only ever happen when (proxy) writer lock also held (excepting careful hacks in tests) */
|
|
unsigned valid: 1; /* always true until (proxy-)writer is being deleted; !valid => !fastpath_ok */
|
|
unsigned fastpath_ok: 1; /* if not ok, fall back to using GUIDs (gives access to the reader-writer match data for handling readers that bumped into resource limits, hence can flip-flop, unlike "valid") */
|
|
uint32_t n_readers;
|
|
struct ddsi_reader **rdary; /* for efficient delivery, null-pointer terminated, grouped by topic */
|
|
};
|
|
|
|
/** @component ddsi_generic_entity */
|
|
ddsi_entityid_t ddsi_to_entityid (unsigned u);
|
|
|
|
/** @component ddsi_generic_entity */
|
|
ddsi_vendorid_t ddsi_get_entity_vendorid (const struct ddsi_entity_common *e);
|
|
|
|
/** @component ddsi_generic_entity */
|
|
uint64_t ddsi_get_entity_instanceid (const struct ddsi_domaingv *gv, const struct ddsi_guid *guid);
|
|
|
|
#if defined (__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* DDSI_ENTITY_H */
|