More examples

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Start with the existing Polling facade example in README, then inspect DefaultPoller, PollerBuilder, and the withExecutorService method. Compare those entry points with the linked poller-demo proof of concept. Done means the README contains clear usage examples for the requested APIs and addresses the stated polling-instance and executor questions.

Written by the indexing model from the issue text.

Description

@dyng
I'm about to start using your polling library. Thank you for publishing it.
I could use some more examples of how you intended it be used.
There is the Polling facade class. You have one example of how to use it in the README.
There is also one implementation of DefaultPoller, but no examples. Examples for PollerBuilder would be welcome.

Do I create one instance of a Poller for every polling job? That is, if I have to poll for 1,000 things, I would create 1,000 instances of a Poller?

Also, what if I want the Poller to use a thread pool? I think I would do that in the PollerBuilder method withExecutorService. Is that right?

Here is my proof-of-concept https://github.com/ahoffer/poller-demo

Dominant language
Java
Stars
38
Forks
5
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.