Liking cljdoc? Tell your friends :D

hive-compose.port

The compose engine port. Every method answers a Result.

The compose engine port. Every method answers a Result.
raw docstring

IActivitycljprotocol

Who talks to a local port right now.

Who talks to a local port right now.

-peersclj

(-peers a ports)

{port #{peer}}: the remote endpoints ("addr:port") of the TCP connections accepted on each of local ports, listening sockets left out. A port nobody is connected to is absent.

{port #{peer}}: the remote endpoints ("addr:port") of the TCP
connections accepted on each of local `ports`, listening sockets left
out. A port nobody is connected to is absent.
sourceraw docstring

IComposeEnginecljprotocol

-profilesclj

(-profiles e profile)

Result<#{name}>: native compose profiles declared by the profile's project.

Result<#{name}>: native compose profiles declared by the profile's project.

-projectsclj

(-projects e)

Result<[{:name :status :config-files}]>: every compose project on the host.

Result<[{:name :status :config-files}]>: every compose project on the host.

-up!clj

(-up! e profile services)

Result<{:out}>: start services detached. An empty services is a no-op.

Result<{:out}>: start `services` detached. An empty `services` is a no-op.

-restart!clj

(-restart! e profile services recreate?)

Result<{:out}>: restart the containers of services in place, or, when recreate?, recreate them (never their depends_on, never volumes). Empty is a no-op.

Result<{:out}>: restart the containers of `services` in place, or, when
`recreate?`, recreate them (never their depends_on, never volumes). Empty is a no-op.

-listedclj

(-listed e profile)

Result<[service]>: services enabled for profile: the always-on ones plus those of its native compose profiles.

Result<[service]>: services enabled for `profile`: the always-on ones plus those of its native compose profiles.

-versionclj

(-version e)

Result<string>: the engine's version, or why it is unavailable.

Result<string>: the engine's version, or why it is unavailable.

-logsclj

(-logs e profile services tail)

Result<{:out}>: the last tail log lines of services (all when empty).

Result<{:out}>: the last `tail` log lines of `services` (all when empty).

-runningclj

(-running e profile)

Result<#{service}>: services of the profile's project whose containers are running.

Result<#{service}>: services of the profile's project whose containers are running.

-stop!clj

(-stop! e profile services)

Result<{:out}>: stop services, keeping containers and volumes. Empty is a no-op.

Result<{:out}>: stop `services`, keeping containers and volumes. Empty is a no-op.

-down!clj

(-down! e profile services)

Result<{:out}>: remove the containers of services, never volumes. Empty is a no-op.

Result<{:out}>: remove the containers of `services`, never volumes. Empty is a no-op.

-closureclj

(-closure e profile)

Result<[service]>: the services profile needs, its depends_on closure included.

Result<[service]>: the services `profile` needs, its depends_on closure included.
source

IContainerAddressescljprotocol

Optional engine capability: the addresses the running containers of a project hold on their networks, so the connections they open to the project's own published ports are not taken for use of it.

Optional engine capability: the addresses the running containers of a
project hold on their networks, so the connections they open to the
project's own published ports are not taken for use of it.

-addressesclj

(-addresses e profile)

Result<#{ip}>: the network addresses of the running containers of the profile's project.

Result<#{ip}>: the network addresses of the running containers of the profile's project.
sourceraw docstring

IDependencyGraphcljprotocol

Optional engine capability: the depends_on edges of a project, so up can leave out what the compose file marks required: false. An engine without it closes over every depends_on entry, as before.

Optional engine capability: the depends_on edges of a project, so `up` can
leave out what the compose file marks `required: false`. An engine without
it closes over every depends_on entry, as before.

-dependenciesclj

(-dependencies e profile)

Result<{service {dep {:required? bool}}}>: the depends_on edges of the services the profile's project defines.

Result<{service {dep {:required? bool}}}>: the depends_on edges of the services the profile's project defines.
sourceraw docstring

IProgramOutcomecljprotocol

Optional runner capability: what a started program left behind once its process is gone, so a program that dies right after start can say why. A runner without it reports the death alone.

Optional runner capability: what a started program left behind once its
process is gone, so a program that dies right after start can say why. A
runner without it reports the death alone.

-exit-codeclj

(-exit-code r pid)

The exit code of pid, started by this runner and since exited; nil while it lives or when this runner did not start it (a pid kept across a restart).

The exit code of `pid`, started by this runner and since exited; nil while
it lives or when this runner did not start it (a pid kept across a restart).

-log-tailclj

(-log-tail r log n)

[line]: the last n non-blank lines of the program log log, [] when it is absent.

[line]: the last `n` non-blank lines of the program log `log`, [] when it is absent.
sourceraw docstring

IProgramRunnercljprotocol

Host programs: the processes a section runs outside compose.

Host programs: the processes a section runs outside compose.

-alive?clj

(-alive? r pid)

True while the process pid lives.

True while the process `pid` lives.

-factsclj

(-facts r dir)

Result<{file-name parsed}>: the build files of dir (shadow-cljs.edn, deps.edn, bb.edn as EDN; project.clj as true).

Result<{file-name parsed}>: the build files of `dir` (shadow-cljs.edn, deps.edn, bb.edn as EDN; project.clj as true).

-halt!clj

(-halt! r pid)

Result<{:pid :stopped?}>: terminate the process group pid leads. Halting a dead pid succeeds.

Result<{:pid :stopped?}>: terminate the process group `pid` leads. Halting a dead pid succeeds.

-listening?clj

(-listening? r port)

True when something accepts connections on local port.

True when something accepts connections on local `port`.

-nrepl-portclj

(-nrepl-port r dir)

The port in dir's .nrepl-port file, nil when absent.

The port in `dir`'s .nrepl-port file, nil when absent.

-start!clj

(-start! r program log)

Result<{:pid}>: start resolved program detached, leading its own process group, output appended to log.

Result<{:pid}>: start resolved `program` detached, leading its own process group, output appended to `log`.
sourceraw docstring

IPublishedPortscljprotocol

Optional engine capability: the host ports the running containers of a project publish, so connections to them can count as use.

Optional engine capability: the host ports the running containers of a
project publish, so connections to them can count as use.

-publishedclj

(-published e profile)

Result<{service #{port}}>: the host ports published by the running containers of the profile's project.

Result<{service #{port}}>: the host ports published by the running containers of the profile's project.
sourceraw docstring

ISwarmcljprotocol

The agents working beside the addon and the channel that reaches them.

The agents working beside the addon and the channel that reaches them.

-agentsclj

(-agents s)

Result<[{:agent/id :agent/status :agent/cwd}]>: the live agents of the swarm, or an error when no swarm answers (no host).

Result<[{:agent/id :agent/status :agent/cwd}]>: the live agents of the
swarm, or an error when no swarm answers (no host).

-notify!clj

(-notify! s event data)

Result<{:channel :direct|:broadcast ..}>: tell the swarm about event (a keyword) with data ({:message string ..}). With :to (an agent id) in data the notice is meant for that agent alone: :direct when it went to it, :broadcast (with :fallback? true) when no directed channel resolved. A notice that cannot be delivered is an error, never a throw.

Result<{:channel :direct|:broadcast ..}>: tell the swarm about `event` (a
keyword) with `data` ({:message string ..}). With `:to` (an agent id) in
`data` the notice is meant for that agent alone: :direct when it went to
it, :broadcast (with :fallback? true) when no directed channel resolved.
A notice that cannot be delivered is an error, never a throw.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close