Protocol Buffers - Google's data interchange format (grpc依赖)
https://developers.google.com/protocol-buffers/
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
245 lines
8.9 KiB
245 lines
8.9 KiB
// Protocol Buffers - Google's data interchange format |
|
// Copyright 2015 Google Inc. All rights reserved. |
|
// https://developers.google.com/protocol-buffers/ |
|
// |
|
// Redistribution and use in source and binary forms, with or without |
|
// modification, are permitted provided that the following conditions are |
|
// met: |
|
// |
|
// * Redistributions of source code must retain the above copyright |
|
// notice, this list of conditions and the following disclaimer. |
|
// * Redistributions in binary form must reproduce the above |
|
// copyright notice, this list of conditions and the following disclaimer |
|
// in the documentation and/or other materials provided with the |
|
// distribution. |
|
// * Neither the name of Google Inc. nor the names of its |
|
// contributors may be used to endorse or promote products derived from |
|
// this software without specific prior written permission. |
|
// |
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
|
|
#import <Foundation/Foundation.h> |
|
|
|
// This CPP symbol can be defined to use imports that match up to the framework |
|
// imports needed when using CocoaPods. |
|
#if !defined(GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS) |
|
#define GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS 0 |
|
#endif |
|
|
|
#if GPB_USE_PROTOBUF_FRAMEWORK_IMPORTS |
|
#import <Protobuf/GPBAny.pbobjc.h> |
|
#import <Protobuf/GPBDuration.pbobjc.h> |
|
#import <Protobuf/GPBTimestamp.pbobjc.h> |
|
#else |
|
#import "GPBAny.pbobjc.h" |
|
#import "GPBDuration.pbobjc.h" |
|
#import "GPBTimestamp.pbobjc.h" |
|
#endif |
|
|
|
NS_ASSUME_NONNULL_BEGIN |
|
|
|
#pragma mark - Errors |
|
|
|
/** NSError domain used for errors. */ |
|
extern NSString *const GPBWellKnownTypesErrorDomain; |
|
|
|
/** Error code for NSError with GPBWellKnownTypesErrorDomain. */ |
|
typedef NS_ENUM(NSInteger, GPBWellKnownTypesErrorCode) { |
|
/** The type_url could not be computed for the requested GPBMessage class. */ |
|
GPBWellKnownTypesErrorCodeFailedToComputeTypeURL = -100, |
|
/** type_url in a Any doesn’t match that of the requested GPBMessage class. */ |
|
GPBWellKnownTypesErrorCodeTypeURLMismatch = -101, |
|
}; |
|
|
|
#pragma mark - GPBTimestamp |
|
|
|
/** |
|
* Category for GPBTimestamp to work with standard Foundation time/date types. |
|
**/ |
|
@interface GPBTimestamp (GBPWellKnownTypes) |
|
|
|
/** The NSDate representation of this GPBTimestamp. */ |
|
@property(nonatomic, readwrite, strong) NSDate *date; |
|
|
|
/** |
|
* 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. |
|
**/ |
|
@property(nonatomic, readwrite) NSTimeInterval timeIntervalSince1970; |
|
|
|
/** |
|
* Initializes a GPBTimestamp with the given NSDate. |
|
* |
|
* @param date The date to configure the GPBTimestamp with. |
|
* |
|
* @return A newly initialized GPBTimestamp. |
|
**/ |
|
- (instancetype)initWithDate:(NSDate *)date; |
|
|
|
/** |
|
* Initializes a GPBTimestamp with the given NSTimeInterval. |
|
* |
|
* @param timeIntervalSince1970 Time interval to configure the GPBTimestamp with. |
|
* |
|
* @return A newly initialized GPBTimestamp. |
|
**/ |
|
- (instancetype)initWithTimeIntervalSince1970:(NSTimeInterval)timeIntervalSince1970; |
|
|
|
@end |
|
|
|
#pragma mark - GPBDuration |
|
|
|
/** |
|
* Category for GPBDuration to work with standard Foundation time type. |
|
**/ |
|
@interface GPBDuration (GBPWellKnownTypes) |
|
|
|
/** |
|
* The NSTimeInterval representation of this GPBDuration. |
|
* |
|
* @note: Not all second/nanos combinations can be represented in a |
|
* NSTimeInterval, so getting this could be a lossy transform. |
|
**/ |
|
@property(nonatomic, readwrite) NSTimeInterval timeInterval; |
|
|
|
/** |
|
* Initializes a GPBDuration with the given NSTimeInterval. |
|
* |
|
* @param timeInterval Time interval to configure the GPBDuration with. |
|
* |
|
* @return A newly initialized GPBDuration. |
|
**/ |
|
- (instancetype)initWithTimeInterval:(NSTimeInterval)timeInterval; |
|
|
|
// These next two methods are deprecated because GBPDuration has no need of a |
|
// "base" time. The older methods were about symmetry with GBPTimestamp, but |
|
// the unix epoch usage is too confusing. |
|
|
|
/** Deprecated, use timeInterval instead. */ |
|
@property(nonatomic, readwrite) NSTimeInterval timeIntervalSince1970 |
|
__attribute__((deprecated("Use timeInterval"))); |
|
/** Deprecated, use initWithTimeInterval: instead. */ |
|
- (instancetype)initWithTimeIntervalSince1970:(NSTimeInterval)timeIntervalSince1970 |
|
__attribute__((deprecated("Use initWithTimeInterval:"))); |
|
|
|
@end |
|
|
|
#pragma mark - GPBAny |
|
|
|
/** |
|
* Category for GPBAny to help work with the message within the object. |
|
**/ |
|
@interface GPBAny (GBPWellKnownTypes) |
|
|
|
/** |
|
* Convenience method to create a GPBAny containing the serialized message. |
|
* This uses type.googleapis.com/ as the type_url's prefix. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param errorPtr Pointer to an error that will be populated if something goes |
|
* wrong. |
|
* |
|
* @return A newly configured GPBAny with the given message, or nil on failure. |
|
*/ |
|
+ (nullable instancetype)anyWithMessage:(nonnull GPBMessage *)message |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Convenience method to create a GPBAny containing the serialized message. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param typeURLPrefix The URL prefix to apply for type_url. |
|
* @param errorPtr Pointer to an error that will be populated if something |
|
* goes wrong. |
|
* |
|
* @return A newly configured GPBAny with the given message, or nil on failure. |
|
*/ |
|
+ (nullable instancetype)anyWithMessage:(nonnull GPBMessage *)message |
|
typeURLPrefix:(nonnull NSString *)typeURLPrefix |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Initializes a GPBAny to contain the serialized message. This uses |
|
* type.googleapis.com/ as the type_url's prefix. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param errorPtr Pointer to an error that will be populated if something goes |
|
* wrong. |
|
* |
|
* @return A newly configured GPBAny with the given message, or nil on failure. |
|
*/ |
|
- (nullable instancetype)initWithMessage:(nonnull GPBMessage *)message |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Initializes a GPBAny to contain the serialized message. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param typeURLPrefix The URL prefix to apply for type_url. |
|
* @param errorPtr Pointer to an error that will be populated if something |
|
* goes wrong. |
|
* |
|
* @return A newly configured GPBAny with the given message, or nil on failure. |
|
*/ |
|
- (nullable instancetype)initWithMessage:(nonnull GPBMessage *)message |
|
typeURLPrefix:(nonnull NSString *)typeURLPrefix |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Packs the serialized message into this GPBAny. This uses |
|
* type.googleapis.com/ as the type_url's prefix. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param errorPtr Pointer to an error that will be populated if something goes |
|
* wrong. |
|
* |
|
* @return Whether the packing was successful or not. |
|
*/ |
|
- (BOOL)packWithMessage:(nonnull GPBMessage *)message |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Packs the serialized message into this GPBAny. |
|
* |
|
* @param message The message to be packed into the GPBAny. |
|
* @param typeURLPrefix The URL prefix to apply for type_url. |
|
* @param errorPtr Pointer to an error that will be populated if something |
|
* goes wrong. |
|
* |
|
* @return Whether the packing was successful or not. |
|
*/ |
|
- (BOOL)packWithMessage:(nonnull GPBMessage *)message |
|
typeURLPrefix:(nonnull NSString *)typeURLPrefix |
|
error:(NSError **)errorPtr; |
|
|
|
/** |
|
* Unpacks the serialized message as if it was an instance of the given class. |
|
* |
|
* @note When checking type_url, the base URL is not checked, only the fully |
|
* qualified name. |
|
* |
|
* @param messageClass The class to use to deserialize the contained message. |
|
* @param errorPtr Pointer to an error that will be populated if something |
|
* goes wrong. |
|
* |
|
* @return An instance of the given class populated with the contained data, or |
|
* nil on failure. |
|
*/ |
|
- (nullable GPBMessage *)unpackMessageClass:(Class)messageClass |
|
error:(NSError **)errorPtr; |
|
|
|
@end |
|
|
|
NS_ASSUME_NONNULL_END
|
|
|