Rename pipeline(_:) to execute(_:), send(command:), execute(_:) (#163)

* pipeline->execute, send-> execute

Signed-off-by: Adam Fowler <[email protected]>

* Fixup remnants

Signed-off-by: Adam Fowler <[email protected]>

* Rename command label from execute

Signed-off-by: Adam Fowler <[email protected]>

* doc changes

Signed-off-by: Adam Fowler <[email protected]>

* Update pipelining docc markdown

Signed-off-by: Adam Fowler <[email protected]>

* Add overview

Signed-off-by: Adam Fowler <[email protected]>

* Fix error in docs, edit execute(_:) comment

Signed-off-by: Adam Fowler <[email protected]>

* Edited pipelining text in README slightly

Signed-off-by: Adam Fowler <[email protected]>

* formatting

Signed-off-by: Adam Fowler <[email protected]>

---------

Signed-off-by: Adam Fowler <[email protected]>

Author: adam-fowler

Package.swift

@@ -29,6 +29,8 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.29.0"),
         .package(url: "https://github.com/apple/swift-nio-transport-services.git", from: "1.23.0"),
         .package(url: "https://github.com/swift-server/swift-service-lifecycle.git", from: "2.8.0"),
+
+        //.package(url: "https://github.com/swiftlang/swift-docc-plugin.git", from: "1.4.5"),
     ],
     targets: [
         .target(

README.md

@@ -37,10 +37,10 @@ All the Valkey commands are in the Commands folder of the Valkey target. These a
 
 ### Pipelining commands
 
-In some cases it is desirable to send multiple commands at one time, without waiting for the response after each command. This is called pipelining. You can do this using the function `pipeline(_:)`. This takes a parameter pack of commands and returns a parameter pack with the responses once all the commands have executed.
+In some cases it is desirable to send multiple commands at one time, without waiting for the response after each command. This is called pipelining. You can do this using the function `execute(_:)`. This function takes multiple commands in the form of a parameter pack. It sends all the commands off at the same time and once it has received all the responses, returns a parameter pack containing the responses.
 
 ```swift
-let (setResponse, getResponse) = await connection.pipeline(
+let (setResponse, getResponse) = await connection.execute(
     SET(key: "MyKey", value: "TestString"),
     GET(key: "MyKey")
 )

Sources/Valkey/Cluster/ValkeyClusterClient.swift

@@ -151,7 +151,7 @@ public final class ValkeyClusterClient: Sendable {
     ///   - `ValkeyClusterError.clientRequestCancelled` if the request is cancelled
     ///   - Other errors if the command execution or parsing fails
     @inlinable
-    public func send<Command: ValkeyCommand>(command: Command) async throws -> Command.Response {
+    public func execute<Command: ValkeyCommand>(_ command: Command) async throws -> Command.Response {
         let hashSlots = command.keysAffected.map { HashSlot(key: $0) }
         var clientSelector: () async throws -> ValkeyNodeClient = {
             try await self.nodeClient(for: hashSlots)
@@ -160,7 +160,7 @@ public final class ValkeyClusterClient: Sendable {
         while !Task.isCancelled {
             do {
                 let client = try await clientSelector()
-                return try await client.send(command: command)
+                return try await client.execute(command)
             } catch ValkeyClusterError.noNodeToTalkTo {
                 // TODO: Rerun node discovery!
             } catch let error as ValkeyClientError where error.errorCode == .commandError {
@@ -581,7 +581,7 @@ public final class ValkeyClusterClient: Sendable {
         try await withThrowingTaskGroup(of: (ValkeyClusterDescription, ValkeyNodeID).self) { taskGroup in
             for voter in voters {
                 taskGroup.addTask {
-                    (try await voter.client.send(command: CLUSTER.SHARDS()), voter.nodeID)
+                    (try await voter.client.execute(CLUSTER.SHARDS()), voter.nodeID)
                 }
             }
 
@@ -625,7 +625,7 @@ public final class ValkeyClusterClient: Sendable {
 
                     for voter in actions.voters {
                         taskGroup.addTask {
-                            (try await voter.client.send(command: CLUSTER.SHARDS()), voter.nodeID)
+                            (try await voter.client.execute(CLUSTER.SHARDS()), voter.nodeID)
                         }
                     }
 

Sources/Valkey/Commands/BitmapCommands.swift

@@ -480,7 +480,7 @@ extension ValkeyClientProtocol {
     /// - Response: [Integer]: The number of bits set to 1.
     @inlinable
     public func bitcount(_ key: ValkeyKey, range: BITCOUNT.Range? = nil) async throws -> Int {
-        try await send(command: BITCOUNT(key, range: range))
+        try await execute(BITCOUNT(key, range: range))
     }
 
     /// Performs arbitrary bitfield integer operations on strings.
@@ -494,7 +494,7 @@ extension ValkeyClientProtocol {
     @inlinable
     @discardableResult
     public func bitfield(_ key: ValkeyKey, operations: [BITFIELD.Operation] = []) async throws -> RESPToken.Array {
-        try await send(command: BITFIELD(key, operations: operations))
+        try await execute(BITFIELD(key, operations: operations))
     }
 
     /// Performs arbitrary read-only bitfield integer operations on strings.
@@ -505,7 +505,7 @@ extension ValkeyClientProtocol {
     /// - Response: [Array]: The result of the subcommand at the same position
     @inlinable
     public func bitfieldRo(_ key: ValkeyKey, getBlocks: [BITFIELDRO.GetBlock] = []) async throws -> [Int] {
-        try await send(command: BITFIELDRO(key, getBlocks: getBlocks))
+        try await execute(BITFIELDRO(key, getBlocks: getBlocks))
     }
 
     /// Performs bitwise operations on multiple strings, and stores the result.
@@ -517,7 +517,7 @@ extension ValkeyClientProtocol {
     @inlinable
     @discardableResult
     public func bitop(operation: BITOP.Operation, destkey: ValkeyKey, keys: [ValkeyKey]) async throws -> Int {
-        try await send(command: BITOP(operation: operation, destkey: destkey, keys: keys))
+        try await execute(BITOP(operation: operation, destkey: destkey, keys: keys))
     }
 
     /// Finds the first set (1) or clear (0) bit in a string.
@@ -532,7 +532,7 @@ extension ValkeyClientProtocol {
     ///     * -1: In case the `bit` argument is 1 and the string is empty or composed of just zero bytes.
     @inlinable
     public func bitpos(_ key: ValkeyKey, bit: Int, range: BITPOS.Range? = nil) async throws -> Int {
-        try await send(command: BITPOS(key, bit: bit, range: range))
+        try await execute(BITPOS(key, bit: bit, range: range))
     }
 
     /// Returns a bit value by offset.
@@ -543,7 +543,7 @@ extension ValkeyClientProtocol {
     /// - Response: The bit value stored at offset.
     @inlinable
     public func getbit(_ key: ValkeyKey, offset: Int) async throws -> Int {
-        try await send(command: GETBIT(key, offset: offset))
+        try await execute(GETBIT(key, offset: offset))
     }
 
     /// Sets or clears the bit at offset of the string value. Creates the key if it doesn't exist.
@@ -555,7 +555,7 @@ extension ValkeyClientProtocol {
     @inlinable
     @discardableResult
     public func setbit(_ key: ValkeyKey, offset: Int, value: Int) async throws -> Int {
-        try await send(command: SETBIT(key, offset: offset, value: value))
+        try await execute(SETBIT(key, offset: offset, value: value))
     }
 
 }