torstenandCopilot
342ffd3e5c
- HandlerMinelayerData: BUILD_RTI Guards für RTI-Abhängigkeiten - svcTabCommon: Export-Header-Fix via Fallback-Target - TrainingAreaBase: Stub-Header für BUILD_RTI=OFF - ddsfts: Include-Pfad und Dependency-Fixes - BUILD_RTI=OFF Compilation vollständig unterstützt Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Entire-Checkpoint: 01M0JNZA586SACX1PRZ2DJAE5S
233 lines
8.2 KiB
C
233 lines
8.2 KiB
C
/*
|
|
* Copyright (c) 2025 Real-Time Innovations, Inc. All rights reserved.
|
|
* No duplications, whole or partial, manual or electronic, may be made
|
|
* without express written permission. Any such copies, or revisions thereof,
|
|
* must display this notice unaltered.
|
|
* This code contains trade secrets of Real-Time Innovations, Inc.
|
|
*/
|
|
|
|
#ifndef commend_activeFacade_h
|
|
#define commend_activeFacade_h
|
|
|
|
|
|
#ifndef event_activeGenerator_h
|
|
#include "event/event_activeGenerator.h"
|
|
#endif
|
|
#ifndef mig_rtps_h
|
|
#include "mig/mig_rtps.h"
|
|
#endif
|
|
#ifndef commend_dll_h
|
|
#include "commend/commend_dll.h"
|
|
#endif
|
|
#ifndef commend_facade_h
|
|
#include "commend/commend_facade.h"
|
|
#endif
|
|
#ifndef osapi_threadFactory_h
|
|
#include "osapi/osapi_threadFactory.h"
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct COMMENDActiveFacade;
|
|
|
|
struct RTIEventActiveDatabase;
|
|
|
|
struct RTINetioConfigurator;
|
|
|
|
/* Doxygen file-level documentation =====================================*/
|
|
/*e \file
|
|
\brief COMMENDActiveFacade interface
|
|
*/
|
|
|
|
/*e \defgroup COMMENDActiveFacadeClass COMMENDActiveFacade
|
|
\ingroup COMMENDFacadeClass
|
|
Implementation of COMMENDFacade as an active object
|
|
*/
|
|
|
|
extern COMMENDDllExport void COMMENDActiveFacade_setListeners(
|
|
struct COMMENDActiveFacade *facade,
|
|
struct RTIEventActiveGeneratorListener *activeListener);
|
|
|
|
extern COMMENDDllExport void COMMENDActiveFacade_incrementActiveObjectCount(
|
|
struct COMMENDActiveFacade *me);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass
|
|
* @brief Wake up all the active objects so that all threads created will
|
|
* terminate. When it returns, all event threads and receiver threads are
|
|
* no longer running, and active facade has entered the "shutdown" mode.
|
|
*/
|
|
extern COMMENDDllExport RTIBool COMMENDActiveFacade_preShutdownWakeup(
|
|
struct COMMENDActiveFacade *me,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass
|
|
* @brief Shut down the active facade. COMMENDActiveFacade_preShutdownWakeup
|
|
* must be called successfully before shutdown function can be called.
|
|
*/
|
|
extern COMMENDDllExport RTIBool COMMENDActiveFacade_shutdown(
|
|
struct COMMENDActiveFacade *me,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass */
|
|
extern COMMENDDllExport void COMMENDActiveFacade_delete(
|
|
struct COMMENDFacade *me,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \defgroup COMMENDActiveFacadeThreadListenerClass
|
|
* COMMENDActiveFacadeThreadListener \ingroup
|
|
* COMMENDActiveFacadeThreadListenerClass \brief Implement this interface to be
|
|
* notified of thread started/stopped.
|
|
*/
|
|
|
|
/*e \ingroup COMMENDActiveFacadeThreadListenerClass
|
|
* \brief called when the thread is started.
|
|
*
|
|
* @pre generator in RTI_EVENT_ACTIVE_OBJECT_STATE_RUNNING
|
|
* @mtsafety <<singleThread>>
|
|
*/
|
|
typedef void (*COMMENDActiveFacadeThreadListenerOnStartedCallback)(
|
|
struct COMMENDActiveFacade *me,
|
|
void *onStartedParam,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeThreadListenerClass
|
|
* \brief called when the thread is about to stop.
|
|
*
|
|
* @pre Object in RTI_EVENT_ACTIVE_OBJECT_STATE_SHUTDOWN or
|
|
* RTI_EVENT_ACTIVE_OBJECT_STATE_STOPPED
|
|
*
|
|
* @mtsafety <<singleThread>>
|
|
*/
|
|
typedef void (*COMMENDActiveFacadeThreadListenerOnStoppedCallback)(
|
|
struct COMMENDActiveFacade *me,
|
|
void *onStoppedParam,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeThreadListenerClass
|
|
* \brief Child of COMMENDActiveActiveThreadListener
|
|
*/
|
|
struct COMMENDActiveFacadeThreadListener {
|
|
/*e Called when a new thread is just started.
|
|
*/
|
|
COMMENDActiveFacadeThreadListenerOnStartedCallback onStarted;
|
|
/*e Associated with the onStarted() method */
|
|
void *onStartedParam;
|
|
/*e Called when the thread is about to stop.
|
|
*/
|
|
COMMENDActiveFacadeThreadListenerOnStoppedCallback onStopped;
|
|
/*e Associated with the onStopped() method */
|
|
void *onStoppedParam;
|
|
};
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass
|
|
* Goal was to make this as simple as possible; many other parameters which
|
|
* may affect the behavior of a facade are just defaults. If you
|
|
* are not happy with the default behavior, we can expose some of them.
|
|
*/
|
|
struct COMMENDActiveFacadeProperty {
|
|
struct COMMENDFacadeProperty parent;
|
|
|
|
/*e There will only be 1 event thread
|
|
@see RTIEventActiveGeneratorProperty
|
|
*/
|
|
struct RTIEventActiveGeneratorProperty activeEventGenerator;
|
|
|
|
/*e there will be as many receiver threads are there are entryports */
|
|
struct RTIEventActiveObjectProperty activeReceiver;
|
|
|
|
/*e Unless all transports will loan the buffer on reception (IP transport
|
|
does not, for example.) the receiver needs some buffer space to hold
|
|
the received messages. This should be the largest size message you
|
|
expect to receive on over ALL transports that do NOT loan the buffer.
|
|
For example, if you are using 4 separate transports, with the following
|
|
capability:
|
|
<verbatim>
|
|
TP max message size loans buffer? alignment req'd
|
|
----- ---------------- ------------- ---------------
|
|
TP1 1K never 32 bytes
|
|
TP2 5K always 8 bytes
|
|
TP3 9K sometimes 16 bytes
|
|
TP4 10M always 4 bytes
|
|
</verbatim>
|
|
Then the required buffer size is 9K.
|
|
*/
|
|
int receiveBufferSize;
|
|
|
|
/*e
|
|
To parse RTPS messages, you need the minimum alignment of
|
|
MIG_RTPS_SUBMESSAGE_ALIGNMENT. But some user supplied transports
|
|
(like VME) require greater alignment. The alignment required for
|
|
receiver thread pool is the maximum alignment required among
|
|
transports that does NOT always loan its buffer.
|
|
In the example for COMMENDActiveFacadeProperty#receiveBufferSize,
|
|
the alignment required is 32 bytes, belonging to TP1.
|
|
*/
|
|
int receiveBufferAlignment;
|
|
/*e Control growth of thread table */
|
|
struct REDAFastBufferPoolGrowthProperty receiveThreadGrowth;
|
|
/*e
|
|
The wakeup period during cleanup to check if cleanup has finished.
|
|
*/
|
|
struct RTINtpTime wakeupPeriodDuringCleanup;
|
|
};
|
|
|
|
#define COMMEND_ACTIVE_FACADE_WAKEUP_CLEANUP_PERIOD_DEFAULT \
|
|
{ \
|
|
0, 10000000 \
|
|
}
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass */
|
|
#define COMMEND_ACTIVE_FACADE_PROPERTY_DEFAULT \
|
|
{ \
|
|
COMMEND_FACADE_PROPERTY_DEFAULT, \
|
|
RTI_EVENT_ACTIVE_GENERATOR_PROPERTY_DEFAULT, /* activeEventGenerator \
|
|
*/ \
|
|
RTI_EVENT_ACTIVE_OBJECT_PROPERTY_DEFAULT, /* activeReceiver */ \
|
|
COMMEND_LENGTH_AUTO, /* receiveBufferSize */ \
|
|
MIG_RTPS_SUBMESSAGE_ALIGNMENT, /* receiveBufferAlignment */ \
|
|
{ 8, \
|
|
REDA_FAST_BUFFER_POOL_UNLIMITED, \
|
|
REDA_FAST_BUFFER_POOL_UNLIMITED }, /* receiveThreadGrowth */ \
|
|
COMMEND_ACTIVE_FACADE_WAKEUP_CLEANUP_PERIOD_DEFAULT /* wakeupPeriodDuringCleanup \
|
|
*/ \
|
|
}
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass
|
|
* @param listener \b In. Listener to be called after each thread is
|
|
* spawned.
|
|
*
|
|
* @return The active facade cast as the interface so you can call
|
|
* the peer methods easily.
|
|
*/
|
|
extern COMMENDDllExport struct COMMENDFacade *COMMENDActiveFacade_new(
|
|
struct REDAWorkerFactory *workerFactory,
|
|
struct RTIEventActiveDatabase *activeDb,
|
|
struct REDAExclusiveArea *tableEa,
|
|
struct RTIClock *clock,
|
|
struct RTIClock *timestampClock,
|
|
const struct COMMENDActiveFacadeThreadListener *threadListener,
|
|
const struct COMMENDActiveFacadeProperty *property,
|
|
struct RTINetioConfigurator *configuratorIn,
|
|
struct RTIOsapiThreadFactory *recvThreadFactory,
|
|
struct RTIOsapiThreadFactory *eventThreadFactory,
|
|
struct RTIOsapiThreadFactory *asynchPubThreadFactory,
|
|
struct REDAWorker *worker);
|
|
|
|
/*e \ingroup COMMENDActiveFacadeClass
|
|
* @param property \b Out. Property used to configure the active facade.
|
|
*
|
|
* @return RTI_TRUE if successful. RTI_FALSE otherwise.
|
|
*/
|
|
extern COMMENDDllExport RTIBool COMMENDActiveFacade_getProperty(
|
|
struct COMMENDFacade *me,
|
|
struct COMMENDActiveFacadeProperty *property);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* commend_activeFacade_h */
|