Instance Methods | Properties | List of all members
GPBTimestamp Class Reference

#import <Timestamp.pbobjc.h>

Inheritance diagram for GPBTimestamp:
Inheritance graph
[legend]

Instance Methods

(instancetype) - initWithDate:
 
(instancetype) - initWithDate:
 
(instancetype) - initWithTimeIntervalSince1970:
 
(instancetype) - initWithTimeIntervalSince1970:
 
- Instance Methods inherited from GPBMessage
(void) - addExtension:value:
 
(void) - addExtension:value:
 
(void) - addUnknownMapEntry:value: [implementation]
 
(void) - addUnknownMapEntry:value: [implementation]
 
(void) - clear
 
(void) - clear
 
(void) - clearExtension:
 
(void) - clearExtension:
 
(nullable NSData *) - data
 
(nullable NSData *) - data
 
(NSData *) - delimitedData
 
(NSData *) - delimitedData
 
(GPBDescriptor *) - descriptor
 
(GPBDescriptor *) - descriptor
 
(NSArray *) - extensionsCurrentlySet
 
(NSArray *) - extensionsCurrentlySet
 
(id- getExistingExtension: [implementation]
 
(id- getExistingExtension: [implementation]
 
(nullable id- getExtension:
 
(nullable id- getExtension:
 
(BOOL- hasExtension:
 
(BOOL- hasExtension:
 
(nullable instancetype) - initWithCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) - initWithCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) - initWithData:error:
 
(nullable instancetype) - initWithData:error:
 
(nullable instancetype) - initWithData:extensionRegistry:error:
 
(nullable instancetype) - initWithData:extensionRegistry:error:
 
(void) - mergeDelimitedFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeDelimitedFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFrom:
 
(void) - mergeFrom:
 
(void) - mergeFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFromCodedInputStream:extensionRegistry: [implementation]
 
(void) - mergeFromData:extensionRegistry:
 
(void) - mergeFromData:extensionRegistry:
 
(size_t) - serializedSize
 
(size_t) - serializedSize
 
(void) - setExtension:index:value:
 
(void) - setExtension:index:value:
 
(void) - setExtension:value:
 
(void) - setExtension:value:
 
(void) - writeDelimitedToCodedOutputStream:
 
(void) - writeDelimitedToCodedOutputStream:
 
(void) - writeDelimitedToOutputStream:
 
(void) - writeDelimitedToOutputStream:
 
(void) - writeToCodedOutputStream:
 
(void) - writeToCodedOutputStream:
 
(void) - writeToOutputStream:
 
(void) - writeToOutputStream:
 

Properties

NSDate * date
 
int32_t nanos
 
int64_t seconds
 
NSTimeInterval timeIntervalSince1970
 
- Properties inherited from GPBMessage
BOOL initialized
 
GPBUnknownFieldSetunknownFields
 

Additional Inherited Members

- Class Methods inherited from GPBMessage
(GPBDescriptor *) + descriptor
 
(GPBDescriptor *) + descriptor
 
(instancetype) + message
 
(instancetype) + message
 
(nullable instancetype) + parseDelimitedFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseDelimitedFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromCodedInputStream:extensionRegistry:error:
 
(nullable instancetype) + parseFromData:error:
 
(nullable instancetype) + parseFromData:error:
 
(nullable instancetype) + parseFromData:extensionRegistry:error:
 
(nullable instancetype) + parseFromData:extensionRegistry:error:
 
- Protected Attributes inherited from GPBMessage
package GPBMessage_StoragePtr messageStorage_
 

Detailed Description

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
    .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec 'Y-m-dTH:M:S.fZ'. Likewise, in Java, one can use the Joda Time's [ISODateTimeFormat.dateTime()]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format.

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
    .setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from Java Instant.now().

Instant now = Instant.now();

Timestamp timestamp =
    Timestamp.newBuilder().setSeconds(now.getEpochSecond())
        .setNanos(now.getNano()).build();

Example 6: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the standard toISOString() method. In Python, a standard datetime.datetime object can be converted to this format using strftime with the time format spec 'Y-m-dTH:M:S.fZ'. Likewise, in Java, one can use the Joda Time's [ISODateTimeFormat.dateTime()]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format.

Definition at line 142 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Timestamp.pbobjc.h.

Method Documentation

◆ initWithDate: [1/2]

- (instancetype) initWithDate: (NSDate *)  date

Initializes a GPBTimestamp with the given NSDate.

Parameters
dateThe date to configure the GPBTimestamp with.
Returns
A newly initialized GPBTimestamp.

Provided by category GPBTimestamp(GBPWellKnownTypes).

◆ initWithDate: [2/2]

- (instancetype) initWithDate: (NSDate *)  date

Initializes a GPBTimestamp with the given NSDate.

Parameters
dateThe date to configure the GPBTimestamp with.
Returns
A newly initialized GPBTimestamp.

Provided by category GPBTimestamp(GBPWellKnownTypes).

◆ initWithTimeIntervalSince1970: [1/2]

- (instancetype) initWithTimeIntervalSince1970: (NSTimeInterval)  timeIntervalSince1970

Initializes a GPBTimestamp with the given NSTimeInterval.

Parameters
timeIntervalSince1970Time interval to configure the GPBTimestamp with.
Returns
A newly initialized GPBTimestamp.

Provided by category GPBTimestamp(GBPWellKnownTypes).

◆ initWithTimeIntervalSince1970: [2/2]

- (instancetype) initWithTimeIntervalSince1970: (NSTimeInterval)  timeIntervalSince1970

Initializes a GPBTimestamp with the given NSTimeInterval.

Parameters
timeIntervalSince1970Time interval to configure the GPBTimestamp with.
Returns
A newly initialized GPBTimestamp.

Provided by category GPBTimestamp(GBPWellKnownTypes).

Property Documentation

◆ date

- (NSDate*) date
readwritenonatomicstrong

The NSDate representation of this GPBTimestamp.

Provided by category GPBTimestamp(GBPWellKnownTypes).

Definition at line 72 of file bloaty/third_party/protobuf/objectivec/GPBWellKnownTypes.h.

◆ nanos

- (int32_t) nanos
readwritenonatomicassign

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

Definition at line 157 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Timestamp.pbobjc.h.

◆ seconds

- (int64_t) seconds
readwritenonatomicassign

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

Definition at line 149 of file bloaty/third_party/protobuf/objectivec/google/protobuf/Timestamp.pbobjc.h.

◆ timeIntervalSince1970

- (NSTimeInterval) timeIntervalSince1970
readwritenonatomicassign

The NSTimeInterval representation of this GPBTimestamp.

Note
: Not all second/nanos combinations can be represented in a NSTimeInterval, so getting this could be a lossy transform.

Provided by category GPBTimestamp(GBPWellKnownTypes).

Definition at line 80 of file bloaty/third_party/protobuf/objectivec/GPBWellKnownTypes.h.


The documentation for this class was generated from the following files:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:01:45