From ffa23ef52a6dbf50af0f447d09eec80ede6b877b Mon Sep 17 00:00:00 2001 From: Jose Date: Fri, 18 Jun 2021 21:03:46 +0200 Subject: [PATCH] Swift README updates --- swift/Glacier2/callback/README.md | 4 ++-- swift/Ice/async/README.md | 4 ++-- swift/Ice/asyncInvocation/README.md | 4 ++-- swift/Ice/bidir/README.md | 4 ++-- swift/Ice/context/README.md | 4 ++-- swift/Ice/hello/README.md | 4 ++-- swift/Ice/interceptor/README.md | 4 ++-- swift/Ice/invoke/README.md | 4 ++-- swift/Ice/latency/README.md | 4 ++-- swift/Ice/minimal/README.md | 8 ++++---- swift/Ice/optional/README.md | 4 ++-- swift/Ice/throughput/README.md | 4 ++-- swift/IceDiscovery/hello/README.md | 4 ++-- swift/IceDiscovery/replication/README.md | 8 ++++---- swift/IceGrid/simple/README.md | 2 +- swift/IceStorm/clock/README.md | 26 ++++++++++++------------ swift/Manual/printer/README.md | 4 ++-- swift/Manual/simpleFilesystem/README.md | 4 ++-- swift/README.md | 10 ++++----- 19 files changed, 55 insertions(+), 55 deletions(-) diff --git a/swift/Glacier2/callback/README.md b/swift/Glacier2/callback/README.md index c8d0de4de4..432be15b3f 100644 --- a/swift/Glacier2/callback/README.md +++ b/swift/Glacier2/callback/README.md @@ -4,7 +4,7 @@ This example demonstrates the use of several Glacier2 features, including To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the Glacier2 router: @@ -16,7 +16,7 @@ glacier2router --Ice.Config=config.glacier2 In a separate window, start the client: ``` -client +./Build/client ``` If you plan to run this demo using clients on different hosts than the diff --git a/swift/Ice/async/README.md b/swift/Ice/async/README.md index a3a9878d61..311701ac00 100644 --- a/swift/Ice/async/README.md +++ b/swift/Ice/async/README.md @@ -5,13 +5,13 @@ well as how to make [oneway][1], [datagram][2], [secure][3], and To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` To test [timeouts][5] you can use 'T' to set an invocation timeout on the diff --git a/swift/Ice/asyncInvocation/README.md b/swift/Ice/asyncInvocation/README.md index 1f31250acc..3b3d2e1bab 100644 --- a/swift/Ice/asyncInvocation/README.md +++ b/swift/Ice/asyncInvocation/README.md @@ -5,11 +5,11 @@ call for the calculations without blocking. To run the demo, first start the server: ``` -server +./Build/server ``` In a second window, start the client: ``` -client +./Build/client ``` diff --git a/swift/Ice/bidir/README.md b/swift/Ice/bidir/README.md index a0bfca08c5..6cf0e610cc 100644 --- a/swift/Ice/bidir/README.md +++ b/swift/Ice/bidir/README.md @@ -6,13 +6,13 @@ incoming connections to the client. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` [1]: https://doc.zeroc.com/ice/3.7/client-server-features/connection-management/bidirectional-connections diff --git a/swift/Ice/context/README.md b/swift/Ice/context/README.md index 1964994946..0ed3583da8 100644 --- a/swift/Ice/context/README.md +++ b/swift/Ice/context/README.md @@ -3,13 +3,13 @@ This demo illustrates how to use [request contexts][1]. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` [1]: https://doc.zeroc.com/ice/3.7/client-side-features/request-contexts diff --git a/swift/Ice/hello/README.md b/swift/Ice/hello/README.md index a3a9878d61..311701ac00 100644 --- a/swift/Ice/hello/README.md +++ b/swift/Ice/hello/README.md @@ -5,13 +5,13 @@ well as how to make [oneway][1], [datagram][2], [secure][3], and To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` To test [timeouts][5] you can use 'T' to set an invocation timeout on the diff --git a/swift/Ice/interceptor/README.md b/swift/Ice/interceptor/README.md index fd0aedf908..fe73044912 100644 --- a/swift/Ice/interceptor/README.md +++ b/swift/Ice/interceptor/README.md @@ -4,13 +4,13 @@ authentication system for securing operations on a remote object. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` The demo models a remote controlled thermostat with operations for getting and setting diff --git a/swift/Ice/invoke/README.md b/swift/Ice/invoke/README.md index 80f79726d2..de6fc905a7 100644 --- a/swift/Ice/invoke/README.md +++ b/swift/Ice/invoke/README.md @@ -3,13 +3,13 @@ This demo illustrates the use of the Ice [streaming API][1]. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` [1]: https://doc.zeroc.com/ice/3.7/client-server-features/dynamic-ice/streaming-interfaces diff --git a/swift/Ice/latency/README.md b/swift/Ice/latency/README.md index f751ee8172..d64306f261 100644 --- a/swift/Ice/latency/README.md +++ b/swift/Ice/latency/README.md @@ -3,11 +3,11 @@ A simple latency test that measures the basic call dispatch delay of Ice. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` diff --git a/swift/Ice/minimal/README.md b/swift/Ice/minimal/README.md index 61e7ed6e10..00fda89ef1 100644 --- a/swift/Ice/minimal/README.md +++ b/swift/Ice/minimal/README.md @@ -3,12 +3,12 @@ client is run a "sayHello" invocation is sent to the server. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` Note that this demo uses port 10000. If port 10000 is not available on your @@ -21,10 +21,10 @@ with the host name or IP address of the server. To run the server with WebSocket support: ``` -server --Ice.Default.Protocol=ws +./Build/server --Ice.Default.Protocol=ws ``` To run the client with WebSocket support: ``` -client --Ice.Default.Protocol=ws +./Build/client --Ice.Default.Protocol=ws ``` diff --git a/swift/Ice/optional/README.md b/swift/Ice/optional/README.md index 7fce5dadd6..880b9d93be 100644 --- a/swift/Ice/optional/README.md +++ b/swift/Ice/optional/README.md @@ -4,13 +4,13 @@ This demo illustrates the use of [optional class members][1] and To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` [1]: https://doc.zeroc.com/ice/3.7/the-slice-language/optional-data-members diff --git a/swift/Ice/throughput/README.md b/swift/Ice/throughput/README.md index 1d8991ea7b..41377db43b 100644 --- a/swift/Ice/throughput/README.md +++ b/swift/Ice/throughput/README.md @@ -5,11 +5,11 @@ that can be achieved using serialized synchronous requests. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` diff --git a/swift/IceDiscovery/hello/README.md b/swift/IceDiscovery/hello/README.md index 9fa353cf53..2bde5bc01c 100644 --- a/swift/IceDiscovery/hello/README.md +++ b/swift/IceDiscovery/hello/README.md @@ -3,13 +3,13 @@ This demo is the Ice hello world demo configured to use [IceDiscovery][1]. To run the demo, first start the server: ``` -server +./Build/server ``` In a separate window, start the client: ``` -client +./Build/client ``` The client and server use IceDiscovery to enable the location of the diff --git a/swift/IceDiscovery/replication/README.md b/swift/IceDiscovery/replication/README.md index c00447be26..78cb59a9bf 100644 --- a/swift/IceDiscovery/replication/README.md +++ b/swift/IceDiscovery/replication/README.md @@ -3,15 +3,15 @@ This demo shows how to use replication with [IceDiscovery][1]. To run the demo, start the 3 servers: ``` -server --Ice.Config=config.server1 -server --Ice.Config=config.server2 -server --Ice.Config=config.server3 +./Build/server --Ice.Config=config.server1 +./Build/server --Ice.Config=config.server2 +./Build/server --Ice.Config=config.server3 ``` In a separate window: ``` -client +./Build/client ``` The client invokes the number of specified iterations with a given diff --git a/swift/IceGrid/simple/README.md b/swift/IceGrid/simple/README.md index 749758193f..f5f411a4f4 100644 --- a/swift/IceGrid/simple/README.md +++ b/swift/IceGrid/simple/README.md @@ -11,7 +11,7 @@ In a separate window: ``` icegridadmin --Ice.Config=config.grid -e "application add application.xml" -client +./Build/client ``` This will deploy the application described in the file diff --git a/swift/IceStorm/clock/README.md b/swift/IceStorm/clock/README.md index 8170631bc3..e2dc6250a9 100644 --- a/swift/IceStorm/clock/README.md +++ b/swift/IceStorm/clock/README.md @@ -15,13 +15,13 @@ current working directory. In a separate window: ``` -subscriber +./Build/subscriber ``` In another window: ``` -publisher +./Build/publisher ``` While the publisher continues to run, "tick" messages should be @@ -40,40 +40,40 @@ Subscriber Options ------------------ ``` -subscriber --oneway +./Build/subscriber --oneway ``` The subscriber receives events as oneway messages. This is the default. ``` -subscriber --datagram +./Build/subscriber --datagram ``` The subscriber receives events as datagrams. ``` -subscriber --twoway +./Build/subscriber --twoway ``` The subscriber receives events as twoway messages. ``` -subscriber --ordered +./Build/subscriber --ordered ``` The subscriber receives events as twoway messages with guaranteed ordering. ``` -subscriber --batch +./Build/subscriber --batch ``` This is an additional flag that forwards datagram and oneway events to the subscriber in batches. ``` -subscriber --id +./Build/subscriber --id ``` This option specifies a unique identity for this subscriber. When @@ -82,13 +82,13 @@ port by setting the `Clock.Subscriber.Endpoints` property. For example: ``` -subscriber --Clock.Subscriber.Endpoints="tcp -p -h " +./Build/subscriber --Clock.Subscriber.Endpoints="tcp -p -h " ``` Replace "tcp" with "udp" when using the --datagram option. ``` -subscriber --retryCount +./Build/subscriber --retryCount ``` This option sets the retry count for a subscriber. This option @@ -99,19 +99,19 @@ Publisher Options ----------------- ``` -publisher --oneway +./Build/publisher --oneway ``` The publisher sends events as oneway messages. This is the default. ``` -publisher --datagram +./Build/publisher --datagram ``` The publisher sends events as datagrams. ``` -publisher --twoway +./Build/publisher --twoway ``` The publisher sends events as twoway messages. diff --git a/swift/Manual/printer/README.md b/swift/Manual/printer/README.md index 77a6580251..a3a76a815b 100644 --- a/swift/Manual/printer/README.md +++ b/swift/Manual/printer/README.md @@ -3,11 +3,11 @@ This demo implements the printer example in the Ice Manual. To run it, start the server in a window: ``` -server +./Build/server ``` In a separate window, run the client: ``` -client +./Build/client ``` diff --git a/swift/Manual/simpleFilesystem/README.md b/swift/Manual/simpleFilesystem/README.md index 1b68b6787d..81b470a53c 100644 --- a/swift/Manual/simpleFilesystem/README.md +++ b/swift/Manual/simpleFilesystem/README.md @@ -4,11 +4,11 @@ end of the client and server Swift mapping chapters. To run it, start the server in a window: ``` -server +./Build/server ``` Then run the client in a separate window: ``` -client +./Build/client ``` diff --git a/swift/README.md b/swift/README.md index 9bf7def8d8..bdb2ceeecf 100644 --- a/swift/README.md +++ b/swift/README.md @@ -30,18 +30,18 @@ In order to build these Ice for Swift sample programs, you need: ### Install required dependencies using Carthage: ``` -carthage update +carthage bootstrap --cache-builds --use-xcframeworks ``` This command will build the `Ice` and `PromiseKit` frameworks required by the sample programs and install them in the `Carthage/Build/` directory. -Note: building `Ice macOS` and `Ice iOS` from source during `carthage update` +Note: building `Ice macOS` and `Ice iOS` from source during `carthage bootstrap` takes some time, please be patient. If you want to use the `slice2swift` and `slice2cpp` compilers from a source distribution, set the `ICE_HOME` environment variable before running -`carthage update`. +`carthage bootstrap`. ### Building the demos @@ -56,8 +56,8 @@ Xcode. ### Running the Demos -For most demos, you can simply run `server` and `client` in separate terminals. -Refer to the README.md file in each demo directory for the exact usage +For most demos, you can simply run `./Build/server` and `./Build/client` in separate +terminals. Refer to the README.md file in each demo directory for the exact usage instructions. Some demos require Ice services such as IceGrid and IceStorm that are not