Home | History | Annotate | Download | only in protobuf
      1 // Protocol Buffers - Google's data interchange format
      2 // Copyright 2008 Google Inc.  All rights reserved.
      3 // https://developers.google.com/protocol-buffers/
      4 //
      5 // Redistribution and use in source and binary forms, with or without
      6 // modification, are permitted provided that the following conditions are
      7 // met:
      8 //
      9 //     * Redistributions of source code must retain the above copyright
     10 // notice, this list of conditions and the following disclaimer.
     11 //     * Redistributions in binary form must reproduce the above
     12 // copyright notice, this list of conditions and the following disclaimer
     13 // in the documentation and/or other materials provided with the
     14 // distribution.
     15 //     * Neither the name of Google Inc. nor the names of its
     16 // contributors may be used to endorse or promote products derived from
     17 // this software without specific prior written permission.
     18 //
     19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30 
     31 syntax = "proto3";
     32 
     33 package google.protobuf;
     34 
     35 option csharp_namespace = "Google.Protobuf.WellKnownTypes";
     36 option cc_enable_arenas = true;
     37 option go_package = "github.com/golang/protobuf/ptypes/timestamp";
     38 option java_package = "com.google.protobuf";
     39 option java_outer_classname = "TimestampProto";
     40 option java_multiple_files = true;
     41 option java_generate_equals_and_hash = true;
     42 option objc_class_prefix = "GPB";
     43 
     44 // A Timestamp represents a point in time independent of any time zone
     45 // or calendar, represented as seconds and fractions of seconds at
     46 // nanosecond resolution in UTC Epoch time. It is encoded using the
     47 // Proleptic Gregorian Calendar which extends the Gregorian calendar
     48 // backwards to year one. It is encoded assuming all minutes are 60
     49 // seconds long, i.e. leap seconds are "smeared" so that no leap second
     50 // table is needed for interpretation. Range is from
     51 // 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
     52 // By restricting to that range, we ensure that we can convert to
     53 // and from  RFC 3339 date strings.
     54 // See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
     55 //
     56 // Example 1: Compute Timestamp from POSIX `time()`.
     57 //
     58 //     Timestamp timestamp;
     59 //     timestamp.set_seconds(time(NULL));
     60 //     timestamp.set_nanos(0);
     61 //
     62 // Example 2: Compute Timestamp from POSIX `gettimeofday()`.
     63 //
     64 //     struct timeval tv;
     65 //     gettimeofday(&tv, NULL);
     66 //
     67 //     Timestamp timestamp;
     68 //     timestamp.set_seconds(tv.tv_sec);
     69 //     timestamp.set_nanos(tv.tv_usec * 1000);
     70 //
     71 // Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
     72 //
     73 //     FILETIME ft;
     74 //     GetSystemTimeAsFileTime(&ft);
     75 //     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
     76 //
     77 //     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
     78 //     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
     79 //     Timestamp timestamp;
     80 //     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
     81 //     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
     82 //
     83 // Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
     84 //
     85 //     long millis = System.currentTimeMillis();
     86 //
     87 //     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
     88 //         .setNanos((int) ((millis % 1000) * 1000000)).build();
     89 //
     90 //
     91 // Example 5: Compute Timestamp from current time in Python.
     92 //
     93 //     now = time.time()
     94 //     seconds = int(now)
     95 //     nanos = int((now - seconds) * 10**9)
     96 //     timestamp = Timestamp(seconds=seconds, nanos=nanos)
     97 //
     98 //
     99 message Timestamp {
    100 
    101   // Represents seconds of UTC time since Unix epoch
    102   // 1970-01-01T00:00:00Z. Must be from from 0001-01-01T00:00:00Z to
    103   // 9999-12-31T23:59:59Z inclusive.
    104   int64 seconds = 1;
    105 
    106   // Non-negative fractions of a second at nanosecond resolution. Negative
    107   // second values with fractions must still have non-negative nanos values
    108   // that count forward in time. Must be from 0 to 999,999,999
    109   // inclusive.
    110   int32 nanos = 2;
    111 }
    112