Document ElasticManager

Author: oschulz

src/elastic.jl

@@ -11,6 +11,35 @@ else
     my_errormonitor(t) = nothing
 end
 
+"""
+    ElasticManager <: Distributed.ClusterManager
+
+A cluster manager that allows for adding and removing workers dynamically.
+
+Constructor:
+
+```julia
+function ElasticManager(;
+    addr=IPv4("127.0.0.1"), port=9009, cookie=nothing,
+    topology=:all_to_all, manage_callback=elastic_no_op_callback, printing_kwargs=()
+)
+```
+
+The manager will listen for worker connections on `addr:port`. Workers have
+to authenticate themselves with `cookie` (randomly generated by default).
+
+If `manage_callback` is set to a user-provided `my_manage_callback`, it will
+be called on the primary Julia process when `Distributed.manage` adds or
+removes an elastic worker. The callback signature is
+
+```julia
+my_manage_callback(mgr::ElasticManager, id::Integer, :register)
+my_manage_callback(mgr::ElasticManager, id::Integer, :deregister)
+```
+
+This can be used to automatically add workers to a `Distributed.WorkerPool`,
+and so on.
+"""
 struct ElasticManager <: Distributed.ClusterManager
     active::Dict{Int, Distributed.WorkerConfig}        # active workers
     pending::Channel{Sockets.TCPSocket}          # to be added workers
@@ -57,9 +86,9 @@ struct ElasticManager <: Distributed.ClusterManager
     end
 end
 
-ElasticManager(port) = ElasticManager(;port=port)
-ElasticManager(addr, port) = ElasticManager(;addr=addr, port=port)
-ElasticManager(addr, port, cookie) = ElasticManager(;addr=addr, port=port, cookie=cookie)
+@deprecate ElasticManager(port) ElasticManager(;port=port)
+@deprecate ElasticManager(addr, port) ElasticManager(;addr=addr, port=port)
+@deprecate ElasticManager(addr, port, cookie) ElasticManager(;addr=addr, port=port, cookie=cookie)
 
 elastic_no_op_callback(::ElasticManager, ::Integer, ::Symbol) = nothing