search

POETSII / Orchestrator

The Orchestrator is the configuration and run-time management system for POETS platforms.
1 stars 1 forks source link

Supervisor handler API #214

Closed m8pple closed 3 years ago

m8pple commented 3 years ago

Section 5.1 of the stable documentation says:

The following API is available to application-writers to support functionality that is common to certain
applications:

However, the things that it describes, like get_safe_directory, message_leader, supervisor_broadcast don't seem to exist. I can't find them anywhere in the master branch or in 1.0.0-alpha.

There is a different API described in 1.0.0-alpha docs. This has things like post, stop_application, and get_output_directory, which I can find in SupervisorAPI.h in the 1.0.0-alpha supervisor branch. However, it says The supervisor API exposes a set of functions that can be called from supervisor handler (as described in the application definition document), but I'm not sure which document (or version of document) it means. I looked at:

and I couldn't find calls to stop, get_output_directory, or post. There is a discussion of a new OnStop handler, but that seems to be more to react to the user calling stop in the UI. I couldn't see any discussion of how a supervisor sends messages to a device (which I think was the intent of post?)

m8pple commented 3 years ago

I guess the SupervisorOutPin replaces post? Or does/did post have a different meaning, e.g. injecting in to the MPI world?

mvousden commented 3 years ago

The note

The supervisor API exposes a set of functions that can be called from supervisor handler (as described in the application definition document)

refers to one of the changes in this PR: https://github.com/POETSII/orchestrator-documentation/pull/9, which has just been approved (and merged).

You'll find calls to stop, get_output_directory, and post referenced therein.

m8pple commented 3 years ago

Great, I'll close and then come back to it if nesc. in a more holistic view of 1.0.0-alpha.