Enhancement #1221

Document timestamp ecoding more precisely

Added by J. Moringen over 11 years ago. Updated over 11 years ago.

Status:ResolvedStart date:10/29/2012
Priority:NormalDue date:
Assignee:J. Moringen% Done:

100%

Category:Documentation
Target version:rsb-0.9

Description

The comments in the Notification protocol buffer file do not explain:

  • Why are some timestamps signed and some unsigned? (seems to be accidental, should all be unsigned)
  • Are all timestamps in mircoseconds? (yes)
  • Which reference point in time does the timestamp encoding use? (UNIX epoch)
  • What about the timezone? (should be UTC)

The "Specification » Events" section in the manual should be improved as well (does not mention UNIX epoch).

Associated revisions

Revision f32adb1a
Added by J. Moringen over 11 years ago

Added details regarding timestamps in specification-event.rst

refs #1221

  • specification-event.rst: reorganized sections slightly; extended
    description of timestamps; added figure explaining
    framework-maintained timestamps

Revision a561fd67
Added by J. Moringen over 11 years ago

Improved descriptions of timestamps in rsb/protocol/{Notification,EventMetaData}.proto

fixes #1221

  • rsb/protocol/Notification.proto: extended documentation strings;
    added link to manual
  • rsb/protocol/EventMetaData.proto: likewise

History

#1 Updated by J. Moringen over 11 years ago

  • Description updated (diff)

#2 Updated by J. Wienke over 11 years ago

no idea how we got signed types, too. +1 for utc. we also need to check the client apis for the way they assign the default value.

#3 Updated by I. Lütkebohle over 11 years ago

Note that Java doesn't have unsigned types, and no type larger than 64bit. Hence, the usual type for storing time values has been a signed 64bit integer containing milliseconds. This might explain why the original usage has been a signed 64bit long.

#4 Updated by J. Moringen over 11 years ago

  • Status changed from New to In Progress
  • Assignee set to J. Moringen
  • % Done changed from 0 to 50

#5 Updated by J. Moringen over 11 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 50 to 100

Applied in changeset rsb-protocol|commit:a561fd673ed0ac765449adeb4553d634652cbce5.

Also available in: Atom PDF