ISSUE-86 Allow passing callbacks to ImapFuture

chibenwa commented 2 years ago

This allow avoiding blocking in calling code to unwrap the future and access the inner value. This empowers reactive/asynchronous/actor systems integrations.

I chose the callback approach instead of using CompletableFuture in order to minimize code changes.

Description

Adds callbacks to ImapFuture

Motivation and Context

Needs to call ImapFuture.get to do anything usefull with this library however it blocks and defeat any reactive/asynchronous/actor system use of this library.

How Has This Been Tested?

Unit test. I will also ensure timely that this solves my original issue.

Screenshots (if appropriate):

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Major release (change is NOT backward compatible with prior release)

Checklist:

[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.

Javadoc.

[x] I have read the CONTRIBUTING document.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.

chibenwa commented 2 years ago

Hi,

I will take a look in the coming days.

I will be able to make those changes solely in ImapFuture by allowing registrations solely on this object.

When a callback is registered, we modify ImapFuture inner structured then immediately run it if the future is done. This makes it fully transparent from the existing interfaces and allows its use for the full asynchronous API, not just for the exec method.

Would this be an evolution of this work that would be welcomed?

Regards,

Benoit

chibenwa commented 2 years ago

Hello,

Any input on this topic dear imapnio maintainers?

Best regards,

Benoit TELLIER

chibenwa commented 2 years ago

Cool!

As a side question, when to expect a 4.3.8 so that I can drop my fork?

Best regards,

Benoit

fansu commented 2 years ago

@chibenwa We just upgrade to 4.3.8, artifacts will be published within a day.

yahoo / imapnio