GPBTimestamp.pbobjc.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. // Generated by the protocol buffer compiler. DO NOT EDIT!
  2. // NO CHECKED-IN PROTOBUF GENCODE
  3. // clang-format off
  4. // source: google/protobuf/timestamp.proto
  5. #import "GPBDescriptor.h"
  6. #import "GPBMessage.h"
  7. #import "GPBRootObject.h"
  8. #if GOOGLE_PROTOBUF_OBJC_VERSION < 30007
  9. #error This file was generated by a newer version of protoc which is incompatible with your Protocol Buffer library sources.
  10. #endif
  11. #if 30007 < GOOGLE_PROTOBUF_OBJC_MIN_SUPPORTED_VERSION
  12. #error This file was generated by an older version of protoc which is incompatible with your Protocol Buffer library sources.
  13. #endif
  14. // @@protoc_insertion_point(imports)
  15. #pragma clang diagnostic push
  16. #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  17. CF_EXTERN_C_BEGIN
  18. NS_ASSUME_NONNULL_BEGIN
  19. #pragma mark - GPBTimestampRoot
  20. /**
  21. * Exposes the extension registry for this file.
  22. *
  23. * The base class provides:
  24. * @code
  25. * + (GPBExtensionRegistry *)extensionRegistry;
  26. * @endcode
  27. * which is a @c GPBExtensionRegistry that includes all the extensions defined by
  28. * this file and all files that it depends on.
  29. **/
  30. GPB_FINAL @interface GPBTimestampRoot : GPBRootObject
  31. @end
  32. #pragma mark - GPBTimestamp
  33. typedef GPB_ENUM(GPBTimestamp_FieldNumber) {
  34. GPBTimestamp_FieldNumber_Seconds = 1,
  35. GPBTimestamp_FieldNumber_Nanos = 2,
  36. };
  37. /**
  38. * A Timestamp represents a point in time independent of any time zone or local
  39. * calendar, encoded as a count of seconds and fractions of seconds at
  40. * nanosecond resolution. The count is relative to an epoch at UTC midnight on
  41. * January 1, 1970, in the proleptic Gregorian calendar which extends the
  42. * Gregorian calendar backwards to year one.
  43. *
  44. * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
  45. * second table is needed for interpretation, using a [24-hour linear
  46. * smear](https://developers.google.com/time/smear).
  47. *
  48. * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
  49. * restricting to that range, we ensure that we can convert to and from [RFC
  50. * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
  51. *
  52. * # Examples
  53. *
  54. * Example 1: Compute Timestamp from POSIX `time()`.
  55. *
  56. * Timestamp timestamp;
  57. * timestamp.set_seconds(time(NULL));
  58. * timestamp.set_nanos(0);
  59. *
  60. * Example 2: Compute Timestamp from POSIX `gettimeofday()`.
  61. *
  62. * struct timeval tv;
  63. * gettimeofday(&tv, NULL);
  64. *
  65. * Timestamp timestamp;
  66. * timestamp.set_seconds(tv.tv_sec);
  67. * timestamp.set_nanos(tv.tv_usec * 1000);
  68. *
  69. * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
  70. *
  71. * FILETIME ft;
  72. * GetSystemTimeAsFileTime(&ft);
  73. * UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
  74. *
  75. * // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
  76. * // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
  77. * Timestamp timestamp;
  78. * timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
  79. * timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
  80. *
  81. * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
  82. *
  83. * long millis = System.currentTimeMillis();
  84. *
  85. * Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
  86. * .setNanos((int) ((millis % 1000) * 1000000)).build();
  87. *
  88. * Example 5: Compute Timestamp from Java `Instant.now()`.
  89. *
  90. * Instant now = Instant.now();
  91. *
  92. * Timestamp timestamp =
  93. * Timestamp.newBuilder().setSeconds(now.getEpochSecond())
  94. * .setNanos(now.getNano()).build();
  95. *
  96. * Example 6: Compute Timestamp from current time in Python.
  97. *
  98. * timestamp = Timestamp()
  99. * timestamp.GetCurrentTime()
  100. *
  101. * # JSON Mapping
  102. *
  103. * In JSON format, the Timestamp type is encoded as a string in the
  104. * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
  105. * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
  106. * where {year} is always expressed using four digits while {month}, {day},
  107. * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
  108. * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
  109. * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
  110. * is required. A proto3 JSON serializer should always use UTC (as indicated by
  111. * "Z") when printing the Timestamp type and a proto3 JSON parser should be
  112. * able to accept both UTC and other timezones (as indicated by an offset).
  113. *
  114. * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
  115. * 01:30 UTC on January 15, 2017.
  116. *
  117. * In JavaScript, one can convert a Date object to this format using the
  118. * standard
  119. * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
  120. * method. In Python, a standard `datetime.datetime` object can be converted
  121. * to this format using
  122. * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
  123. * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
  124. * the Joda Time's [`ISODateTimeFormat.dateTime()`](
  125. * http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
  126. * ) to obtain a formatter capable of generating timestamps in this format.
  127. **/
  128. GPB_FINAL @interface GPBTimestamp : GPBMessage
  129. /**
  130. * Represents seconds of UTC time since Unix epoch
  131. * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  132. * 9999-12-31T23:59:59Z inclusive.
  133. **/
  134. @property(nonatomic, readwrite) int64_t seconds;
  135. /**
  136. * Non-negative fractions of a second at nanosecond resolution. Negative
  137. * second values with fractions must still have non-negative nanos values
  138. * that count forward in time. Must be from 0 to 999,999,999
  139. * inclusive.
  140. **/
  141. @property(nonatomic, readwrite) int32_t nanos;
  142. // NOTE: There are some Objective-C specific methods/properties in
  143. // GPBWellKnownTypes.h that will likely be useful.
  144. @end
  145. NS_ASSUME_NONNULL_END
  146. CF_EXTERN_C_END
  147. #pragma clang diagnostic pop
  148. // @@protoc_insertion_point(global_scope)
  149. // clang-format on