参数命名为“自发生以来的时间”

时间:2015-09-21 19:46:18

标签: api naming-conventions naming api-design iot

我正在构建一个简单的API来使用从小型网络传感器/设备发送的数据(想想arduino,raspberry pi等)。我想记录此远程设备上发生事件的合理准确的时间戳。由于潜在的连接问题,事件可能并不总是立即发送回服务器。我不想依赖于同步设备上的时钟,如果我可以避免它,所以我将尝试发回一个参数,该参数只包含自事件发生以来的秒数。因此,例如,在设备上检测到事件,但由于某种原因,它会在5秒后被发送到服务器。数据将包含一个数字“5”,表示这是在5秒前根据设备的内部时钟发生的。然后服务器将获取自己的时钟时间,并减去5秒钟以生成时间戳。

我想提出一个参数名称来描述这个有意义的时间跨度。一些选项可能包括:

  • TimeSince
  • TIMEAGO
  • DurationSince

然而,由于这是一个简单的数字字段,我希望名称包含度量单位,以便更加清晰,例如:

  • SecondsSince
  • SecondsAgo
  • TimeAgoSeconds

有没有人遇到过这种事情的共同和/或明智的命名惯例?自事件发生以来的时间,以及在何处以及如何在参数名称中指示单位?我的命名思想都没有真正感觉“正确”,但也许这里的一些讨论可能有助于确定一种方法比另一种更好。

感谢。

1 个答案:

答案 0 :(得分:0)

我的感觉是ElapsedSeconds听起来很合理。

现在,你在缓冲这些事件吗?如果他们打算每隔n秒发生一次"你如何处理错过的价值?我的意思是,你可以缓冲n个事件,如果它们没有传输,你可能会覆盖第一个n。当您传输所有缓冲区时,如何解释丢失的缓冲区?根据应用程序的不同,有兴趣在那一刻为该事件填写NaN。

这有意义吗?