145 lines
4.6 KiB
C++
145 lines
4.6 KiB
C++
/**
|
|
* @file include/ActivMiddleware/ActivFramework/Messages.h
|
|
*
|
|
* @brief Header file for exported framework message classes.
|
|
*/
|
|
|
|
#if (!defined ACTIV_FRAMEWORK_MESSAGES_H)
|
|
#define ACTIV_FRAMEWORK_MESSAGES_H
|
|
|
|
#include "ActivMiddleware/ActivFramework/External.h"
|
|
|
|
#include "ActivMiddleware/ActivBase/ISerializableMessage.h"
|
|
#include "ActivMiddleware/ActivBase/GenericMessages.h"
|
|
#include "ActivMiddleware/ActivFramework/IProcess.h"
|
|
#include "ActivMiddleware/ActivFramework/ServiceId.h"
|
|
#include "ActivMiddleware/Misc/SerializableContainerHelper.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
/**
|
|
* @brief Open service request.
|
|
*/
|
|
class OpenServiceRequest : public ISerializableMessage
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Default constructor.
|
|
*
|
|
* m_version is set to m_currentVersion, but can be overridden if required.
|
|
*/
|
|
ACTIV_FRAMEWORK_API OpenServiceRequest();
|
|
|
|
ACTIV_FRAMEWORK_API virtual StatusCode Serialize(MessageBuilder &messageBuilder) const ACTIV_OVERRIDE;
|
|
ACTIV_FRAMEWORK_API virtual StatusCode Deserialize(MessageValidator &messageValidator) ACTIV_OVERRIDE;
|
|
|
|
static const byte_t m_highestVersion = 3; ///< Highest supported version.
|
|
ACTIV_FRAMEWORK_API static const byte_t m_currentVersion; ///< Current version used by client side.
|
|
|
|
byte_t m_version;
|
|
ServiceId m_serviceId;
|
|
|
|
private:
|
|
StatusCode SerializeGeneric(MessageBuilder &messageBuilder) const;
|
|
StatusCode SerializeVersioned(MessageBuilder &messageBuilder) const;
|
|
StatusCode DeserializeGeneric(MessageValidator &messageValidator);
|
|
StatusCode DeserializeVersioned(MessageValidator &messageValidator);
|
|
|
|
class Message;
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Open service response. The response implicitly matches the version of the request.
|
|
*/
|
|
class OpenServiceResponse : public ISerializableMessage
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Default constructor.
|
|
*/
|
|
ACTIV_FRAMEWORK_API OpenServiceResponse();
|
|
|
|
/**
|
|
* @brief Constructor.
|
|
*
|
|
* @param serviceId id for the service.
|
|
*/
|
|
ACTIV_FRAMEWORK_API OpenServiceResponse(const ServiceId &serviceId);
|
|
|
|
ACTIV_FRAMEWORK_API virtual StatusCode Serialize(MessageBuilder &messageBuilder) const ACTIV_OVERRIDE;
|
|
ACTIV_FRAMEWORK_API virtual StatusCode Deserialize(MessageValidator &messageValidator) ACTIV_OVERRIDE;
|
|
|
|
ServiceId m_serviceId;
|
|
|
|
private:
|
|
StatusCode SerializeGeneric(MessageBuilder &messageBuilder) const;
|
|
StatusCode SerializeVersioned(MessageBuilder &messageBuilder) const;
|
|
StatusCode DeserializeGeneric(MessageValidator &messageValidator);
|
|
StatusCode DeserializeVersioned(MessageValidator &messageValidator);
|
|
|
|
class Message;
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief SYSTEM_MESSAGE_ENDPOINT_SHUTDOWN, SYSTEM_MESSAGE_ENDPOINT_DIE.
|
|
*
|
|
* Message received by subscribing to EndPointSubject.
|
|
*/
|
|
class SystemMessageEndPointIdSet
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Serialize the message.
|
|
*
|
|
* @param messageBuilder builder to use.
|
|
* @param endPointIdSet set of endpoints shutting down.
|
|
*
|
|
* @retval STATUS_CODE_SUCCESS
|
|
* @retval ...
|
|
*/
|
|
ACTIV_FRAMEWORK_API static StatusCode Serialize(MessageBuilder &messageBuilder, const EndPointIdSet &endPointIdSet);
|
|
|
|
/**
|
|
* @brief Deserialize the message.
|
|
*
|
|
* @param messageValidator
|
|
*
|
|
* @retval STATUS_CODE_SUCCESS
|
|
* @retval ...
|
|
*/
|
|
ACTIV_FRAMEWORK_API StatusCode Deserialize(MessageValidator &messageValidator);
|
|
|
|
EndPointIdSet m_endPointIdSet; ///< set of endpoints that are shutting down
|
|
|
|
private:
|
|
typedef SerializableObjectContainerHelper<EndPointIdSet, EndPointId> Serializer;
|
|
};
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Message published when a process's state changes.
|
|
*/
|
|
class ProcessStateChangeMessage
|
|
{
|
|
public:
|
|
typedef GenericMessages::Field<1, ProcessId, GenericMessages::MandatoryTraits> ProcessIdField;
|
|
typedef GenericMessages::Field<2, IProcess::State, GenericMessages::MandatoryTraits> StateField;
|
|
|
|
typedef ACTIV_GM_FIELD_LIST<ProcessIdField, StateField> FieldList;
|
|
typedef GenericMessages::Definition<FieldList> Definition;
|
|
};
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_FRAMEWORK_MESSAGES_H)
|