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

More flexible services for RPC #1206

Merged
merged 4 commits into from
Jan 8, 2024
Merged

More flexible services for RPC #1206

merged 4 commits into from
Jan 8, 2024

Conversation

tomvanmele
Copy link
Member

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

@Licini
Copy link
Contributor

Licini commented Nov 2, 2023

nice!

@tomvanmele
Copy link
Member Author

tomvanmele commented Nov 2, 2023

# special.py

from compas.rpc import Server
from compas.rpc import Dispatcher


class SpecialService(Dispatcher):
    def special(self):
        return "special"


def start_service():
    server = Server(("0.0.0.0", 1753))
    service = SpecialService()
    server.register_instance(service)
    server.serve_forever()


if __name__ == "__main__":
    import argparse
    parser = argparse.ArgumentParser()
    args, unknown = parser.parse_known_args()
    start_service()
# client.py

import os
from compas.rpc import Proxy

proxy = Proxy(service="special", cwd=os.path.dirname("__file__"))

proxy.special()

Copy link
Member

@gonzalocasas gonzalocasas left a comment

Choose a reason for hiding this comment

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

lgtm + feedback

Comment on lines 31 to 32
# server.register_function(server.ping)
# server.register_function(server.remote_shutdown)
Copy link
Member

Choose a reason for hiding this comment

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

delete

src/compas/rpc/proxy.py Outdated Show resolved Hide resolved
@@ -0,0 +1,42 @@
"""
Minimal example of a "special" service.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not very convinced about the naming, "special" but why? What's special about it? :) Do you mean "Custom" or "UserDefined"?

Copy link
Member Author

Choose a reason for hiding this comment

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

not it is just an example. perhaps it should be removed and the example added to the docs

Copy link
Member

Choose a reason for hiding this comment

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

👍

@tomvanmele tomvanmele merged commit eba265d into main Jan 8, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants