Skip to content
This repository was archived by the owner on Aug 1, 2023. It is now read-only.

Update document #148

Merged
merged 4 commits into from
May 30, 2019
Merged

Update document #148

merged 4 commits into from
May 30, 2019

Conversation

HirotoShioi
Copy link
Contributor

Updated NodeIPC documentation to include description to include about extended message handling.

@HirotoShioi HirotoShioi requested review from erikd and ksaric as code owners May 13, 2019 06:13
@HirotoShioi HirotoShioi self-assigned this May 13, 2019
@ksaric
Copy link
Contributor

ksaric commented May 13, 2019

@HirotoShioi When you see a failure, you can take a look at the "Details" and try to figure out why is it failing.

@CodiePP CodiePP added the wip Work In Progress label May 13, 2019
@HirotoShioi HirotoShioi removed the wip Work In Progress label May 14, 2019
Copy link
Contributor

@ksaric ksaric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make the description a little closer to an actual use case?

@@ -207,6 +207,9 @@ When the \textit{Daedalus} calls and starts the \textit{Node}, it also opens up
First, the \textit{Node} sends the message \textbf{Started} back to the \textit{Daedalus} to inform him that the communication can begin.
After that, \textit{Daedalus} sends the message \textbf{QueryPort} to the \textit{Node}, and the \textit{Node} responds with the free port it found using \textbf{ReplyPort PORTNUM} that is going to be used for starting the HTTP "server" serving the \textit{JSON API} which they can then use to communicate further.\\

Not only does the \textit{Node} responds to the message, but it can also perform some IO actions depending on the message sent from the client.
For instance, you can have the node to start an new process when the client sends \textbf{Started} or have it so that node will kill its thread/process when it responds with \textbf{ReplyPort PORTNUM}.\\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

start an new process - start a new process.
"you can have the node to start an new process when the client sends \textbf{Started} or have it so that node will kill its thread/process when it " - what does this mean? Maybe an example where the response is an action called "FetchInfo SystemInfo" where the client needs to fetch the client info and return it to the server. That would require IO.

@ksaric
Copy link
Contributor

ksaric commented May 29, 2019

You can rebase on top of #171 (develop).

Copy link
Contributor

@ksaric ksaric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@@ -1,6 +1,6 @@
let
# adding the haskell environment for running lhs2tex
pkgs = import (import ./../nixpkgs.nix) { config = import ./../config.nix; };
pkgs = import (import ./../nixpkgs.nix) { config = import ./../default.nix; };
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we even need nixpkgs.nix but this is not required to be the bleeding edge anyway, so it's good.

@HirotoShioi HirotoShioi merged commit 5715f04 into develop May 30, 2019
@HirotoShioi HirotoShioi deleted the hiroto/GH-97 branch May 30, 2019 23:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants