subscription_messages.hpp

Go to the documentation of this file.

#pragma once
 
#include "../message_id.hpp"
#include <cstdint>
 
namespace commrat {
 
struct SubscribeRequestPayload {
    uint32_t subscriber_base_addr{0};    
    uint8_t mailbox_index{0};            
    int64_t requested_period_ms{0};      
};
 
struct SubscribeReplyPayload {
    int64_t actual_period_ms{0};       
    bool success{false};               
    uint32_t error_code{0};            
};
 
struct UnsubscribeRequestPayload {
    uint32_t subscriber_base_addr{0};    
};
 
struct UnsubscribeReplyPayload {
    bool success{true};                  
};
 
// ============================================================================
// Message Definitions with Compile-Time IDs
// ============================================================================
 
// Subscribe request/reply pair with explicit IDs
using SubscribeRequest = MessageDefinition<
    SubscribeRequestPayload,
    MessagePrefix::System,
    SystemSubPrefix::Subscription,
    0x0001  // Explicit ID for request
>;
 
using SubscribeReply = MessageDefinition<
    SubscribeReplyPayload,
    MessagePrefix::System,
    SystemSubPrefix::Subscription,
    0x0002  // Explicit ID for reply (could use Reply<SubscribeRequest> with negative ID)
>;
 
// Unsubscribe request/reply pair with explicit IDs
using UnsubscribeRequest = MessageDefinition<
    UnsubscribeRequestPayload,
    MessagePrefix::System,
    SystemSubPrefix::Subscription,
    0x0003
>;
 
using UnsubscribeReply = MessageDefinition<
    UnsubscribeReplyPayload,
    MessagePrefix::System,
    SystemSubPrefix::Subscription,
    0x0004
>;
 
// Type aliases for accessing payloads
using SubscribeRequestType = typename SubscribeRequest::Payload;
using SubscribeReplyType = typename SubscribeReply::Payload;
using UnsubscribeRequestType = typename UnsubscribeRequest::Payload;
using UnsubscribeReplyType = typename UnsubscribeReply::Payload;
 
} // namespace commrat