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

Review the documentation: Getting Started Tutorial #384

Closed
mpostol opened this issue Oct 28, 2019 · 7 comments · Fixed by #405
Closed

Review the documentation: Getting Started Tutorial #384

mpostol opened this issue Oct 28, 2019 · 7 comments · Fixed by #405
Assignees
Labels
Documentation Documentation modification request In progress In waiting Waiting for some external events

Comments

@mpostol
Copy link
Owner

mpostol commented Oct 28, 2019

Getting Started Tutorial.

@mpostol mpostol added the Documentation Documentation modification request label Oct 28, 2019
@mpostol mpostol added this to the Networking backlog milestone Oct 28, 2019
@mpostol mpostol modified the milestones: Networking backlog, Planning Nov 16, 2019
@mpostol mpostol self-assigned this Nov 16, 2019
mpostol added a commit that referenced this issue Nov 17, 2019
- expanded description in READMEGettingStartedTutorial.md related to the implementation of the Consumer and Producer roles to help HMI implementations.
@mpostol mpostol added In progress In waiting Waiting for some external events labels Nov 17, 2019
@mpostol mpostol mentioned this issue Nov 17, 2019
mpostol added a commit that referenced this issue Nov 17, 2019
@mpostol
Copy link
Owner Author

mpostol commented Nov 17, 2019

part of #394

@210342
Copy link

210342 commented Nov 17, 2019

I think it is worth to mention that IEncodingFactory implementation can be found in NuGet package UAOOI.Networking.Encoding. I have used it in my application. Also it would be helpful to provide an example of schema for a producer/consumer configuration file.

@mpostol
Copy link
Owner Author

mpostol commented Nov 17, 2019

@210342 thanks for comments. I understand that the proposals can be recognized as future requests and are not a blocker for your work.

@mpostol
Copy link
Owner Author

mpostol commented Nov 21, 2019

Add information about dependency on commonservicelocator. It is used to ger parts required to compose the application.

@mpostol
Copy link
Owner Author

mpostol commented Nov 21, 2019

There must be added that each instance of the DataManagementSetup creates a new instance of selected Roles. The DataManagementSetup can create consumer, producer of both depending on the configuration.

@mpostol
Copy link
Owner Author

mpostol commented Dec 4, 2019

commonservicelocator research on

commonservicelocator see also:

Decision

Using commonservicelocator the following assumptions are hold

  • the library doesn't depend on a concrete container - it is only client-side
  • the footprint is small
  • lack of service locator is mitigated by the default implementation of the services
  • it can be easily implemented for any kind of container.

We will keep using it inside the library. End-user may select any framework that is compliant with this.

@Drutol
Copy link
Contributor

Drutol commented Dec 4, 2019

Hmm...

in not .NET API Browser

Neither Microsoft.Practices.ServiceLocation is there.

depends on Microsoft.Extensions.DependencyInjection

Not sure why would you want to use the whole package.
https://www.nuget.org/packages/Microsoft.Extensions.DependencyInjection.Abstractions/

On top of it the library itself would need no dependency altogether.

implements container ServiceCollection

Abstractions do not implement this class.

don't agree - there are a lot of errors and misunderstandings

Well, the main point made there is that it obscures dependencies required by the components. The API of the library is not self descriptive and requires digging through the documentation to find out what's up. In my opinion that's very valid point, class is requesting something at random instead of getting the thing from its constructor.

don't require a concrete container
can be easily implemented for any container

These apply to the IServiceCollection too.

Just wanted to comment on that, I'm not really hung up on removing ServiceLocator but wanted to clarify a few things.

@mpostol mpostol removed the question label Dec 4, 2019
mpostol added a commit that referenced this issue Dec 4, 2019
mpostol added a commit that referenced this issue Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation modification request In progress In waiting Waiting for some external events
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants