Переглянути джерело

rename all UnsafeMutableRawPointer variables to have "underlying" in their names

Tim Burks 9 роки тому
батько
коміт
617a674407

+ 3 - 3
Packages/gRPC/Sources/Call.swift

@@ -132,8 +132,8 @@ public class Call {
   ///
   /// - Parameter call: the underlying C representation
   /// - Parameter owned: true if this instance is responsible for deleting the underlying call
-  init(call: UnsafeMutableRawPointer, owned: Bool, completionQueue: CompletionQueue) {
-    self.underlyingCall = call
+  init(underlyingCall: UnsafeMutableRawPointer, owned: Bool, completionQueue: CompletionQueue) {
+    self.underlyingCall = underlyingCall
     self.owned = owned
     self.completionQueue = completionQueue
     self.pendingMessages = []
@@ -157,7 +157,7 @@ public class Call {
       completionQueue.operationGroups[operations.tag] = operations
       let mutex = CallLock.sharedInstance.mutex
       mutex.lock()
-      let error = cgrpc_call_perform(underlyingCall, operations.operations, operations.tag)
+      let error = cgrpc_call_perform(underlyingCall, operations.underlyingOperations, operations.tag)
       mutex.unlock()
       return CallError.callError(grpcCallError:error)
   }

+ 1 - 1
Packages/gRPC/Sources/Client.swift

@@ -84,6 +84,6 @@ public class Client {
   /// - Returns: a Call object that can be used to perform the request
   public func makeCall(host:String, method:String, timeout:TimeInterval) -> Call {
     let call = cgrpc_client_create_call(underlyingClient, method, host, timeout)!
-    return Call(call:call, owned:true, completionQueue:self.completionQueue)
+    return Call(underlyingCall:call, owned:true, completionQueue:self.completionQueue)
   }
 }

+ 2 - 2
Packages/gRPC/Sources/Handler.swift

@@ -48,7 +48,7 @@ public class Handler {
 
   /// A Call object that can be used to respond to the request
   lazy var call: Call = {
-    return Call(call: cgrpc_handler_get_call(self.underlyingHandler),
+    return Call(underlyingCall: cgrpc_handler_get_call(self.underlyingHandler),
                 owned: false,
                 completionQueue: self.completionQueue)
     }()
@@ -92,7 +92,7 @@ public class Handler {
   ///
   /// - Returns: a CallError indicating the result of requesting the call
   func requestCall(tag: Int) -> CallError {
-    let error = cgrpc_handler_request_call(underlyingHandler, requestMetadata.array, tag)
+    let error = cgrpc_handler_request_call(underlyingHandler, requestMetadata.underlyingArray, tag)
     return CallError.callError(grpcCallError: error)
   }
 

+ 11 - 11
Packages/gRPC/Sources/Metadata.swift

@@ -49,18 +49,18 @@ private struct MetadataPair {
 public class Metadata {
 
   /// Pointer to underlying C representation
-  var array: UnsafeMutableRawPointer
+  var underlyingArray: UnsafeMutableRawPointer
 
-  init(array: UnsafeMutableRawPointer) {
-    self.array = array
+  init(underlyingArray: UnsafeMutableRawPointer) {
+    self.underlyingArray = underlyingArray
   }
 
   public init() {
-    self.array = cgrpc_metadata_array_create();
+    self.underlyingArray = cgrpc_metadata_array_create();
   }
 
   public init(_ pairs: [[String:String]]) {
-    array = cgrpc_metadata_array_create();
+    underlyingArray = cgrpc_metadata_array_create();
     for pair in pairs {
       for key in pair.keys {
         if let value = pair[key] {
@@ -71,7 +71,7 @@ public class Metadata {
   }
 
   public init(_ pairs: [String:String]) {
-    array = cgrpc_metadata_array_create();
+    underlyingArray = cgrpc_metadata_array_create();
     for key in pairs.keys {
       if let value = pairs[key] {
         add(key:key, value:value)
@@ -80,24 +80,24 @@ public class Metadata {
   }
 
   deinit {
-    cgrpc_metadata_array_destroy(array);
+    cgrpc_metadata_array_destroy(underlyingArray);
   }
 
   public func count() -> Int {
-    return cgrpc_metadata_array_get_count(array);
+    return cgrpc_metadata_array_get_count(underlyingArray);
   }
 
   public func key(index: Int) -> (String) {
-    return String(cString:cgrpc_metadata_array_get_key_at_index(array, index),
+    return String(cString:cgrpc_metadata_array_get_key_at_index(underlyingArray, index),
                   encoding:String.Encoding.utf8)!;
   }
 
   public func value(index: Int) -> (String) {
-    return String(cString:cgrpc_metadata_array_get_value_at_index(array, index),
+    return String(cString:cgrpc_metadata_array_get_value_at_index(underlyingArray, index),
                   encoding:String.Encoding.utf8)!;
   }
 
   public func add(key:String, value:String) {
-    cgrpc_metadata_array_append_metadata(array, key, value)
+    cgrpc_metadata_array_append_metadata(underlyingArray, key, value)
   }
 }

+ 20 - 20
Packages/gRPC/Sources/Operation.swift

@@ -39,17 +39,17 @@ import Foundation // for String.Encoding
 class Operation {
 
   /// Pointer to underlying C representation
-  var observer: UnsafeMutableRawPointer
+  var underlyingObserver: UnsafeMutableRawPointer
 
   /// Initializes an Operation Observer
   ///
   /// - Parameter observer: the underlying C representation
-  init(observer: UnsafeMutableRawPointer) {
-    self.observer = observer
+  init(underlyingObserver: UnsafeMutableRawPointer) {
+    self.underlyingObserver = underlyingObserver
   }
 
   deinit {
-    cgrpc_observer_destroy(observer);
+    cgrpc_observer_destroy(underlyingObserver);
   }
 }
 
@@ -60,7 +60,7 @@ class Operation_SendInitialMetadata : Operation {
   ///
   /// - Parameter metadata: the initial metadata to send
   init(metadata:Metadata) {
-    super.init(observer:cgrpc_observer_create_send_initial_metadata(metadata.array))
+    super.init(underlyingObserver:cgrpc_observer_create_send_initial_metadata(metadata.underlyingArray))
   }
 }
 
@@ -71,8 +71,8 @@ class Operation_SendMessage : Operation {
   ///
   /// - Parameter message: the message to send
   init(message:ByteBuffer) {
-    super.init(observer:cgrpc_observer_create_send_message())
-    cgrpc_observer_send_message_set_message(observer, message.underlyingByteBuffer);
+    super.init(underlyingObserver:cgrpc_observer_create_send_message())
+    cgrpc_observer_send_message_set_message(underlyingObserver, message.underlyingByteBuffer);
   }
 }
 
@@ -81,7 +81,7 @@ class Operation_SendCloseFromClient : Operation {
 
   /// Initializes an Operation Observer
   init() {
-    super.init(observer:cgrpc_observer_create_send_close_from_client())
+    super.init(underlyingObserver:cgrpc_observer_create_send_close_from_client())
   }
 }
 
@@ -96,9 +96,9 @@ class Operation_SendStatusFromServer : Operation {
   init(status:Int,
        statusDetails:String,
        metadata:Metadata) {
-    super.init(observer:cgrpc_observer_create_send_status_from_server(metadata.array))
-    cgrpc_observer_send_status_from_server_set_status(observer, Int32(status));
-    cgrpc_observer_send_status_from_server_set_status_details(observer, statusDetails);
+    super.init(underlyingObserver:cgrpc_observer_create_send_status_from_server(metadata.underlyingArray))
+    cgrpc_observer_send_status_from_server_set_status(underlyingObserver, Int32(status));
+    cgrpc_observer_send_status_from_server_set_status_details(underlyingObserver, statusDetails);
   }
 }
 
@@ -107,14 +107,14 @@ class Operation_ReceiveInitialMetadata : Operation {
 
   /// Initializes an Operation Observer
   init() {
-    super.init(observer:cgrpc_observer_create_recv_initial_metadata())
+    super.init(underlyingObserver:cgrpc_observer_create_recv_initial_metadata())
   }
 
   /// Gets the initial metadata that was received
   ///
   /// - Returns: metadata
   func metadata() -> Metadata {
-    return Metadata(array:cgrpc_observer_recv_initial_metadata_get_metadata(observer));
+    return Metadata(underlyingArray:cgrpc_observer_recv_initial_metadata_get_metadata(underlyingObserver));
   }
 }
 
@@ -123,14 +123,14 @@ class Operation_ReceiveMessage : Operation {
 
   /// Initializes an Operation Observer
   init() {
-    super.init(observer:cgrpc_observer_create_recv_message())
+    super.init(underlyingObserver:cgrpc_observer_create_recv_message())
   }
 
   /// Gets the message that was received
   ///
   /// - Returns: message
   func message() -> ByteBuffer? {
-    if let b = cgrpc_observer_recv_message_get_message(observer) {
+    if let b = cgrpc_observer_recv_message_get_message(underlyingObserver) {
       return ByteBuffer(underlyingByteBuffer:b)
     } else {
       return nil
@@ -143,28 +143,28 @@ class Operation_ReceiveStatusOnClient : Operation {
 
   /// Initializes an Operation Observer
   init() {
-    super.init(observer:cgrpc_observer_create_recv_status_on_client())
+    super.init(underlyingObserver:cgrpc_observer_create_recv_status_on_client())
   }
 
   /// Gets the trailing metadata that was received
   ///
   /// - Returns: metadata
   func metadata() -> Metadata {
-    return Metadata(array:cgrpc_observer_recv_status_on_client_get_metadata(observer));
+    return Metadata(underlyingArray:cgrpc_observer_recv_status_on_client_get_metadata(underlyingObserver));
   }
 
   /// Gets the status code that was received
   ///
   /// - Returns: status code
   func status() -> Int {
-    return cgrpc_observer_recv_status_on_client_get_status(observer);
+    return cgrpc_observer_recv_status_on_client_get_status(underlyingObserver);
   }
 
   /// Gets the status message that was received
   ///
   /// - Returns: status message
   func statusDetails() -> String {
-    return String(cString:cgrpc_observer_recv_status_on_client_get_status_details(observer),
+    return String(cString:cgrpc_observer_recv_status_on_client_get_status_details(underlyingObserver),
                   encoding:String.Encoding.utf8)!
   }
 }
@@ -174,6 +174,6 @@ class Operation_ReceiveCloseOnServer : Operation {
 
   /// Initializes an Operation Observer
   init() {
-    super.init(observer:cgrpc_observer_create_recv_close_on_server())
+    super.init(underlyingObserver:cgrpc_observer_create_recv_close_on_server())
   }
 }

+ 4 - 4
Packages/gRPC/Sources/OperationGroup.swift

@@ -59,7 +59,7 @@ class OperationGroup {
   var operationsArray : [Operation]?
 
   /// Pointer to underlying C representation
-  var operations : UnsafeMutableRawPointer!
+  var underlyingOperations : UnsafeMutableRawPointer!
 
   /// Completion handler that is called when the group completes
   var completion : ((Bool) -> Void)
@@ -72,10 +72,10 @@ class OperationGroup {
        completion: @escaping ((Bool) -> Void)) {
     self.call = call
     self.operationsArray = operations
-    self.operations = cgrpc_operations_create()
-    cgrpc_operations_reserve_space_for_operations(self.operations, Int32(operations.count))
+    self.underlyingOperations = cgrpc_operations_create()
+    cgrpc_operations_reserve_space_for_operations(self.underlyingOperations, Int32(operations.count))
     for operation in operations {
-      cgrpc_operations_add_operation(self.operations, operation.observer)
+      cgrpc_operations_add_operation(self.underlyingOperations, operation.underlyingObserver)
     }
     self.completion = completion
     let mutex = OperationGroupTagLock.sharedInstance.mutex