-
Notifications
You must be signed in to change notification settings - Fork 39
Async Http Client #77
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
Closed
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d6b548c
Replace sendRequests with an async approach
joelwurtz 9b7bbf2
Force callback to be set
joelwurtz b6c5434
Use specification of promises/a+
joelwurtz 5628eee
Replace "should" by "must"
joelwurtz 1c569e7
Add documentation about states, add method to get value and reason of…
joelwurtz 5a868bd
Add note about promises/a+
joelwurtz 21e01c1
Fix typo on request <-> response
joelwurtz f2af5cb
Fix documentation from an user point of view
joelwurtz fe7d30b
Use string for constant, add wait method, add some documentation abou…
joelwurtz 55b159f
Fixing phpdoc, rename getError to getException
joelwurtz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<?php | ||
|
||
namespace Http\Client; | ||
|
||
use Psr\Http\Message\RequestInterface; | ||
|
||
/** | ||
* Sends a PSR-7 Request in an asynchronous way by returning a Promise. | ||
* | ||
* @author Joel Wurtz <[email protected]> | ||
*/ | ||
interface HttpAsyncClient | ||
{ | ||
/** | ||
* Sends a PSR-7 request in an asynchronous way. | ||
* | ||
* @param RequestInterface $request | ||
* | ||
* @return Promise | ||
* | ||
* @throws Exception | ||
*/ | ||
public function sendAsyncRequest(RequestInterface $request); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
<?php | ||
|
||
namespace Http\Client; | ||
|
||
use Psr\Http\Message\ResponseInterface; | ||
|
||
/** | ||
* Promise represents a response that may not be available yet, but will be resolved at some point in future. | ||
* It acts like a proxy to the actual response. | ||
* | ||
* This interface is an extension of the promises/a+ specification https://promisesaplus.com/ | ||
* Value is replaced by an object where its class implement a Psr\Http\Message\RequestInterface. | ||
* Reason is replaced by an object where its class implement a Http\Client\Exception. | ||
* | ||
* @author Joel Wurtz <[email protected]> | ||
*/ | ||
interface Promise | ||
{ | ||
/** | ||
* Pending state, promise has not been fulfilled or rejected. | ||
*/ | ||
const PENDING = "pending"; | ||
|
||
/** | ||
* Fulfilled state, promise has been fulfilled with a ResponseInterface object. | ||
*/ | ||
const FULFILLED = "fulfilled"; | ||
|
||
/** | ||
* Rejected state, promise has been rejected with an Exception object. | ||
*/ | ||
const REJECTED = "rejected"; | ||
|
||
/** | ||
* Add behavior for when the promise is resolved or rejected (response will be available, or error happens). | ||
* | ||
* If you do not care about one of the cases, you can set the corresponding callable to null | ||
* The callback will be called when the response or exception arrived and never more than once. | ||
* | ||
* @param callable $onFulfilled Called when a response will be available. | ||
* @param callable $onRejected Called when an error happens. | ||
* | ||
* You must always return the Response in the interface or throw an Exception. | ||
* | ||
* @return Promise Always returns a new promise which is resolved with value of the executed callback (onFulfilled / onRejected). | ||
*/ | ||
public function then(callable $onFulfilled = null, callable $onRejected = null); | ||
|
||
/** | ||
* Get the state of the promise, one of PENDING, FULFILLED or REJECTED | ||
* | ||
* @return int | ||
*/ | ||
public function getState(); | ||
|
||
/** | ||
* Return the value of the promise (fulfilled). | ||
* | ||
* @return ResponseInterface Response Object only when the Promise is fulfilled. | ||
* | ||
* @throws \LogicException When the promise is not fulfilled. | ||
*/ | ||
public function getResponse(); | ||
|
||
/** | ||
* Return the reason of the promise (rejected). | ||
* | ||
* @return Exception Exception Object only when the Promise is rejected. | ||
* | ||
* If the exception is an instance of Http\Client\Exception\HttpException it will contain | ||
* the response object with the status code and the http reason. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i think this should go above the |
||
* | ||
* @throws \LogicException When the promise is not rejected. | ||
*/ | ||
public function getException(); | ||
|
||
/** | ||
* Wait for the promise to be fulfilled or rejected. | ||
* | ||
* When this method returns, the request has been resolved and the appropriate callable has terminated. | ||
*/ | ||
public function wait(); | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Return the reason why the promise was rejected."?
and we could mention that if this exception is a HttpException, it will contain the Response object with the error status code inside. (in the hope that people will be less confused when trying to figure out how to get to that information)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what do you think about the wording "Get the reason why the promise was rejected." ?