From 12da424c9ae7fe35b926bfb5761ec1a300ccbf0f Mon Sep 17 00:00:00 2001 From: Jorge Canizales <jcanizales@google.com> Date: Wed, 2 Sep 2015 22:22:34 -0700 Subject: [PATCH] nit: Documentation and formatting. --- src/objective-c/GRPCClient/GRPCCall.h | 7 +++++++ src/objective-c/GRPCClient/private/GRPCRequestHeaders.h | 4 ++-- src/objective-c/GRPCClient/private/GRPCRequestHeaders.m | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/objective-c/GRPCClient/GRPCCall.h b/src/objective-c/GRPCClient/GRPCCall.h index f4d1838da7..c9b6e6d6e2 100644 --- a/src/objective-c/GRPCClient/GRPCCall.h +++ b/src/objective-c/GRPCClient/GRPCCall.h @@ -55,6 +55,13 @@ extern id const kGRPCHeadersKey; extern id const kGRPCTrailersKey; +// The container of the request headers of an RPC conforms to this protocol, which is a subset of +// NSMutableDictionary's interface. It will become a NSMutableDictionary later on. +// The keys of this container are the header names, which per the HTTP standard are case- +// insensitive. They are stored in lowercase (which is how HTTP/2 mandates them on the wire), and +// can only consist of ASCII characters. +// A header value is a NSString object (with only ASCII characters), unless the header name has the +// suffix "-bin", in which case the value has to be a NSData object. @protocol GRPCRequestHeaders <NSObject> @property(nonatomic, readonly) NSUInteger count; diff --git a/src/objective-c/GRPCClient/private/GRPCRequestHeaders.h b/src/objective-c/GRPCClient/private/GRPCRequestHeaders.h index 066f71a8f6..1391b5725f 100644 --- a/src/objective-c/GRPCClient/private/GRPCRequestHeaders.h +++ b/src/objective-c/GRPCClient/private/GRPCRequestHeaders.h @@ -47,6 +47,6 @@ - (void)setObject:(id)obj forKeyedSubscript:(NSString *)key; - (void)removeAllObjects; -- (void)removeObjectForKey:(NSString *)aKey; +- (void)removeObjectForKey:(NSString *)key; -@end \ No newline at end of file +@end diff --git a/src/objective-c/GRPCClient/private/GRPCRequestHeaders.m b/src/objective-c/GRPCClient/private/GRPCRequestHeaders.m index d4bbbdf84a..d0d8de89a1 100644 --- a/src/objective-c/GRPCClient/private/GRPCRequestHeaders.m +++ b/src/objective-c/GRPCClient/private/GRPCRequestHeaders.m @@ -117,4 +117,4 @@ static void CheckKeyValuePairIsValid(NSString *key, id value) { - (grpc_metadata *)grpc_metadataArray { return _proxy.grpc_metadataArray; } -@end \ No newline at end of file +@end -- GitLab