Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[new] PART-1 NamedPipeService #3452

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

cschuchardt88
Copy link
Member

@cschuchardt88 cschuchardt88 commented Aug 6, 2024

Description

What this service does, is allow communication with the node, when it is running as a windows service or systemd service. Communication between the neo-cli and node, allowing a developer to receive all, if not more information from the node.

Type of change

  • Optimization (the change is only an optimization)
  • Style (the change is only a code style for better maintenance or standard purpose)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

image

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Member

@shargon shargon left a comment

Choose a reason for hiding this comment

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

this plugin only send the exceptions?

src/Plugins/NamedPipeService/NamedPipeEndPoint.cs Outdated Show resolved Hide resolved
src/Neo.Extensions/TaskExtensions.cs Show resolved Hide resolved

namespace Neo.Plugins.Models.Payloads
{
internal sealed class PipeNullPayload : IPipeMessage
Copy link
Member

Choose a reason for hiding this comment

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

Why we need it? maybe ping, but null?

Copy link
Member Author

@cschuchardt88 cschuchardt88 Aug 8, 2024

Choose a reason for hiding this comment

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

If you request a Block for example. If may not be at the that height yet or doesn't exists (if you request something else). In this case we return null. Could return exception too depending on what it is.

Copy link
Member Author

Choose a reason for hiding this comment

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

In short, just for empty protocol messages. Like command GetBlockHeight

@cschuchardt88
Copy link
Member Author

cschuchardt88 commented Aug 8, 2024

this plugin only send the exceptions?

Does both will send and log to Utility.Log. Reason for this is because when I create the Windows/systemd service The CLI will need to know what is happening with the node. So it can display error to user.

@cschuchardt88 cschuchardt88 marked this pull request as ready for review August 25, 2024 01:07
@cschuchardt88 cschuchardt88 marked this pull request as draft August 25, 2024 01:09
@cschuchardt88 cschuchardt88 marked this pull request as ready for review August 25, 2024 03:24
@cschuchardt88 cschuchardt88 added blocker Issues that are blocking other issues. Check issues details to see what it is blocking. waiting for review Plugins labels Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocker Issues that are blocking other issues. Check issues details to see what it is blocking. Plugins waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants