GPBTimestamp.pbobjc.h 6.1 KB

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