117 lines
6.3 KiB
C
117 lines
6.3 KiB
C
/* Windows冻结电能持久适配:独占energy.store,目录与下载各持有不可变临时快照。
|
|
* 初次使用清零实例,所有调用串行;协议重建不销毁此对象,不创建采集线程。 */
|
|
#ifndef IEC104_EXAMPLE_ENERGY_FREEZE_H
|
|
#define IEC104_EXAMPLE_ENERGY_FREEZE_H
|
|
|
|
#include "IEC60870_EnergyFreezeFile.h"
|
|
#include "IEC60870_Time.h"
|
|
|
|
#define EXAMPLE_ENERGY_FREEZE_DIRECTORY_CAPACITY 30U
|
|
#define EXAMPLE_ENERGY_FREEZE_NAME_CAPACITY 64U
|
|
|
|
typedef struct {
|
|
char name[EXAMPLE_ENERGY_FREEZE_NAME_CAPACITY];
|
|
uint32_t size;
|
|
IEC60870_CP56Time2a_t time;
|
|
uint32_t offset;
|
|
} ExampleEnergyFreezeEntry;
|
|
|
|
typedef struct {
|
|
IEC60870_EnergyFreeze_t core;
|
|
void *storage;
|
|
void *directory_file;
|
|
void *read_file;
|
|
char parent[200];
|
|
char device_name[128];
|
|
const char *const *units;
|
|
ExampleEnergyFreezeEntry entries[EXAMPLE_ENERGY_FREEZE_DIRECTORY_CAPACITY];
|
|
size_t entry_count;
|
|
uint32_t read_size;
|
|
bool directory_active;
|
|
bool opened;
|
|
uint8_t banks[2][IEC60870_ENERGY_FREEZE_WIRE_MAX + 32U];
|
|
} ExampleEnergyFreeze;
|
|
|
|
/**
|
|
* 功能:独占打开已有父目录中的energy.store,新建文件写格式头,已有空档或损坏档拒绝重建。
|
|
* 输入参数:self——调用方持有的模块实例;parent——已存在的宿主父目录;config——初始化配置;device_name——导出文件使用的设备名称;units——各电能点的单位字符串表。
|
|
* 输出参数:self——本次操作更新的实例或工作区。
|
|
* 返回值:true表示请求的资源或存储实例已准备就绪;false表示输入校验、资源获取或恢复失败。
|
|
* 说明:parent为已存在目录;config点表和units借用至Close。已有空档/损坏档拒绝重建。
|
|
* 每次commit三个阶段分别FlushFileBuffers;真实掉电保证依赖介质同步契约。
|
|
*/
|
|
bool Example_Energy_Freeze_Open(ExampleEnergyFreeze *self, const char *parent,
|
|
const IEC60870_EnergyFreezeConfig_t *config, const char *device_name,
|
|
const char *const *units);
|
|
/**
|
|
* 功能:依次释放下载、目录缓存和持久文件句柄,令核心退出可用状态;energy.store内容保留。
|
|
* 输入参数:self——调用方持有的模块实例。
|
|
* 输出参数:self——本次操作更新的实例或工作区。
|
|
* 返回值:无。
|
|
* 说明:调用方先结束引用本实例的协议会话,避免关闭后仍访问快照。
|
|
*/
|
|
void Example_Energy_Freeze_Close(ExampleEnergyFreeze *self);
|
|
|
|
/**
|
|
* 功能:日目录先验证SEAL,包括空窗;不能先凭数据不存在过滤,否则会掩盖已封存记录丢失。
|
|
* 输入参数:self——调用方持有的模块实例;name——文件名或显式长度的协议名称;length——本次数据或名称的有效字节数。
|
|
* 输出参数:self——本次操作更新的实例或工作区。
|
|
* 返回值:true表示完整目录快照已发布;false表示名称、记录校验或快照生成失败。
|
|
* 说明:仅精确接受HISTORY/FRZ和HISTORY/FLOWREV;失败不发布部分目录。
|
|
*/
|
|
bool Example_Energy_Freeze_Directory_Open(ExampleEnergyFreeze *self,
|
|
const uint8_t *name, size_t length);
|
|
/**
|
|
* 功能:返回当前活动目录的缓存条目数;目录未打开或实例为空时返回0,不读取介质。
|
|
* 输入参数:self——调用方持有的模块实例。
|
|
* 输出参数:无独立输出参数。
|
|
* 返回值:当前目录可枚举的条目数;目录未打开时为0。
|
|
* 说明:无。
|
|
*/
|
|
size_t Example_Energy_Freeze_Directory_Count(const ExampleEnergyFreeze *self);
|
|
/**
|
|
* 功能:按从0开始的索引复制活动目录条目;目录无效或索引越界返回false,保持entry原内容。
|
|
* 输入参数:self——调用方持有的模块实例;index——本次条目、点或逻辑槽的下标;entry——目录条目。
|
|
* 输出参数:entry——目录条目。
|
|
* 返回值:true表示目录条目已复制到entry;false表示实例、目录或索引无效。
|
|
* 说明:无。
|
|
*/
|
|
bool Example_Energy_Freeze_Directory_Get(const ExampleEnergyFreeze *self,
|
|
size_t index, ExampleEnergyFreezeEntry *entry);
|
|
/**
|
|
* 功能:只结束目录枚举,保留条目及其XML缓存,使随后按名称下载仍取得已公布的版本。
|
|
* 输入参数:self——调用方持有的模块实例。
|
|
* 输出参数:self——本次操作更新的实例或工作区。
|
|
* 返回值:无。
|
|
* 说明:结束枚举但保留缓存版本,供随后读文件取得同一份内容。
|
|
*/
|
|
void Example_Energy_Freeze_Directory_Close(ExampleEnergyFreeze *self);
|
|
/**
|
|
* 功能:缓存命中沿用已公布的XML;下载另建快照,不受后续召目录或底层轮转影响。
|
|
* 输入参数:self——调用方持有的模块实例;name——文件名或显式长度的协议名称;length——本次数据或名称的有效字节数;size——实际字节数回写位置。
|
|
* 输出参数:self——本次操作更新的实例或工作区;size——实际字节数回写位置。
|
|
* 返回值:true表示独立下载快照已打开并写回长度;false表示名称或快照准备失败。
|
|
* 说明:无。
|
|
*/
|
|
bool Example_Energy_Freeze_Read_Open(ExampleEnergyFreeze *self,
|
|
const uint8_t *name, size_t length, uint32_t *size);
|
|
/**
|
|
* 功能:从已打开的独立下载快照按偏移读取,范围必须完全位于read_size内,短读也返回false。
|
|
* 输入参数:self——调用方持有的模块实例;offset——从起点计算的字节偏移;buffer——调用方提供的数据缓冲;length——本次数据或名称的有效字节数。
|
|
* 输出参数:buffer——调用方提供的数据缓冲。
|
|
* 返回值:true表示指定范围的数据已完整读出;false表示范围非法、读取失败或短读。
|
|
* 说明:不依赖当前目录或核心记录;I/O失败可能已改写部分buffer,调用方不能使用失败片段。
|
|
*/
|
|
bool Example_Energy_Freeze_Read(ExampleEnergyFreeze *self, uint32_t offset,
|
|
uint8_t *buffer, size_t length);
|
|
/**
|
|
* 功能:结束当前下载并删除其独立临时快照,清零长度;保留目录缓存及持久介质,允许重复关闭。
|
|
* 输入参数:self——调用方持有的模块实例。
|
|
* 输出参数:self——本次操作更新的实例或工作区。
|
|
* 返回值:无。
|
|
* 说明:无。
|
|
*/
|
|
void Example_Energy_Freeze_Read_Close(ExampleEnergyFreeze *self);
|
|
|
|
#endif /* IEC104_EXAMPLE_ENERGY_FREEZE_H */
|