hollodotme/fast-cgi-client
A PHP FastCGI client for sending synchronous and asynchronous requests to PHP-FPM over network or unix domain sockets, with support for handling multiple requests, unit tests, and integration tests.
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
This file covers the 4.x releases. For previous major versions see: 3.x, 2.x, 1.x
PHP >= 8.0 is required. Support for PHP 7.1 - 7.4 was dropped. Version 3.x keeps supporting these PHP versions and still gets bug fixes, but no new features. - #57
The fileinfo extension is required. It is used to detect the MIME type of files in multipart form-data
requests. - #81
The content of a request is a ComposesRequestContent object instead of a string. - #57
AbstractRequest#__construct() expects an optional content object as second argument:
__construct( string $scriptFilename, ?ComposesRequestContent $content = null )AbstractRequest#setContent() expects a ComposesRequestContent object and also sets the content type of the
request. A content type that was set before is overwritten.ProvidesRequestData#getContent() returns ?ComposesRequestContent instead of string.newWithRequestContent(), introduced in 3.1.0, was removed from all request classes.CONTENT_LENGTH
parameter and once for the body. Changes to the content object after it was passed to the request are taken
into account. - #76, #97# Previous versions
$request = new PostRequest( '/path/to/script.php', http_build_query( ['key' => 'value'] ) );
$request = PostRequest::newWithRequestContent( '/path/to/script.php', new UrlEncodedFormData( ['key' => 'value'] ) );
$request = new PostRequest( '/path/to/script.php', 'plain text' );
$request->setContentType( 'text/plain' );
# Since 4.0.0
$request = new PostRequest( '/path/to/script.php', new UrlEncodedFormData( ['key' => 'value'] ) );
$request = new PostRequest( '/path/to/script.php', new PlainText( 'plain text' ) );
Content types that are not covered by the classes in hollodotme\FastCGI\RequestContents need an own implementation
of the ComposesRequestContent interface.
The interface ConfiguresSocketConnection has the new method getStreamSelectTimeout() : int, which must be added
to own implementations of this interface. - #82
Client#readResponses() and Client#readReadyResponses() throw the exception, if a response cannot be read,
e.g. a TimedoutException. Before, such responses were skipped silently. Unknown socket IDs are still skipped.
Client#waitForResponse() and Client#waitForResponses() time out after the read/write timeout of the connection,
if no timeout is passed. The failure callbacks of requests without response are notified with a TimedoutException
then. Before, both methods waited until the response was received, also for scripts that run longer than the
read/write timeout before they send output. Pass a timeout that is long enough for your scripts.
The interface ProvidesResponseData has the new method getStatusCode() : int, which must be added to own
implementations of this interface.
The public constant Socket::STREAM_SELECT_USEC was removed in favour of the configurable stream select timeout
of the socket connections. - #82
Classes that extend AbstractRequest or a request class must adapt overridden setContent() and getContent()
methods and calls of parent::__construct() to the content object. New public methods may collide with methods of
own subclasses: Client#tryRequest(), Client#tryAsyncRequest(), AbstractRequest#setQueryParams(),
AbstractRequest#getQueryParams(), AbstractRequest#getQueryString() and Response#getStatusCode(). - #57
Response#getStatusCode(), which returns the status code of the Status header, or 200 if there is none.PlainText for content type text/plain.NetworkSocket and
UnixDomainSocket. It defines how long the client waits when checking for responses. The default is
Defaults::STREAM_SELECT_TIMEOUT (200 ms), which is the value used in previous versions. - #82, #18AbstractRequest#setQueryParams(). They are sent
as QUERY_STRING and appended to the REQUEST_URI. AbstractRequest#getQueryParams() and
AbstractRequest#getQueryString() return the parameters and the encoded query string. - #83Client#tryRequest() and Client#tryAsyncRequest(), which send a request again on another socket, if
writing the request to a socket failed. - #84ReadFailedException is thrown, if a
packet has an unsupported protocol version, an unexpected record type, the ID of another request or, in case of
an end-request record, an unexpected length. - #78, #95match and mixed.
chr() when encoding packets are limited to one byte, because values out of this range are
deprecated in PHP 8.5.make test-compatibility).make phpcs, make phpcbf). - #75, #98make docs-serve, make docs-build) and deployed to GitHub Pages. The README gives a short overview.docker compose plugin instead of the standalone docker-compose binary.Most of these fixes were also released for 3.x in version 3.1.8.
Client#waitForResponse() and Client#waitForResponses() did not return, if the server did not respond, even if a
timeout was passed. After the timeout the failure callbacks of the request are notified with a TimedoutException
now.ReadFailedException is thrown now. - #78, #95NameValuePairEncoder#decodePairs() decoded names and values of 16 MiB and more with a wrong length.PacketEncoder#encodePacket()
splits content that is longer than one record into consecutive records of the same type."0" was not sent.TimedoutException or WriteFailedException is thrown now.readResponse() and the other methods reading responses applied to writing the next
request on the same socket as well. The read/write timeout of the connection applies again.readReadyResponses(), and its callbacks were notified again by handleReadyResponses() and
waitForResponses().Client#hasResponse() and Client#waitForResponse() checked the stream of a socket whose response was already read
with readResponse(). hasResponse() returned false, and true once the server closed the idle connection.
waitForResponse() blocked until then. Such a socket has its response now.ReadFailedException is thrown now.Client#getSocketIdsHavingResponse() and the methods based on it could throw a ValueError on PHP 8, if the
sockets of the client had no stream, e.g. after a failed connect.ReadFailedException is thrown now. - #78, #95All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
Content-Transfer-Encoding: base64 header from multipart block for filesmime_content_type(), if availablenull nor a resourcedocker-compose.yml with composer archives via .gitattributes.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any
accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request
content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData
andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int respectively in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each
request (which it is not). Also the first constructor parameter of the Response class was removed with this change.
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int>
to Client#getSocketIdsHavingResponse() : array<int> in order to reflect the correct semantics of the returned array
of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced
with Response#getOutput(). The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given
key. - #35Response#getHeader(string $headerKey) : array
and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour
of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking)
change was necessary and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR. This refers mainly to the
error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in
interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter
of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation
addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single
responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the
respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective
response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the
respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the
respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call
the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response
directly.sendRequest and sendAsyncRequest expect to get an object of
interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of
interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE
in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol
hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the
socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
Content-Transfer-Encoding: base64 header from multipart block for filesmime_content_type(), if availablenull nor a resourcedocker-compose.yml with composer archives via .gitattributes.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any
accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request
content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData
andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int respectively in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each
request (which it is not). Also the first constructor parameter of the Response class was removed with this change.
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int>
to Client#getSocketIdsHavingResponse() : array<int> in order to reflect the correct semantics of the returned array
of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced
with Response#getOutput(). The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given
key. - #35Response#getHeader(string $headerKey) : array
and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour
of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking)
change was necessary and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR. This refers mainly to the
error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in
interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter
of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation
addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single
responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the
respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective
response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the
respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the
respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call
the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response
directly.sendRequest and sendAsyncRequest expect to get an object of
interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of
interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE
in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol
hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the
socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
Content-Transfer-Encoding: base64 header from multipart block for filesmime_content_type(), if availablenull nor a resourcedocker-compose.yml with composer archives via .gitattributes.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int respectively in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed with this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
null nor a resourcedocker-compose.yml with composer archives via .gitattributes.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int respectively in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed with this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
docker-compose.yml with composer archives via .gitattributes.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int resepctivly in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed wiht this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
.gitattributes file to exclude non-relevant files/directories from archives/releases installed by composer - #58bin/fcgiget in composer.json as it is a potential security issue (because bin/fcgiget accepts any accessible fastCGI endpoint and may be exposed in some setups)AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int resepctivly in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed wiht this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
AbstractRequest due to a final constructor. - #56
See also: #55newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int resepctivly in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed wiht this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning and Keep a CHANGELOG.
newWithRequestContent to all request classes in order to simplify the use of the new request content type composers.error_reporting=-1 for CI and tests in order to capture deprecation warningsPlease take notice of the backwards incompatible changes (BC breaks) documented below in the changelog of 3.0.0-alpha & 3.0.0-beta.
The socket conection parameter was moved from the Client's constructor to
Client#sendRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : ProvidesResponseData andClient#sendAsyncRequest(ConfiguresSocketConnection $connection, ProvidesRequestData $request) : intin order to allow sending (equal) requests to different FastCGI servers using the same Client instance. - #45
Removed method ProvidesResponseData#getRequestId() : int and Response#getRequestId() : int resepctivly in order
to avoid confusion about the semantics of the term "request ID" and misusage by assuming it is a unique ID for each request (which it is not).
Also the first constructor parameter of the Response class was removed wiht this change. - #39
Renamed all $requestId(s) parameters to $socketId(s) in order to reflect the correct semantics of the ID. - #39
Renamed method Client#getRequestIdsHavingResponse() : array<int> to Client#getSocketIdsHavingResponse() : array<int> in order to reflect
the correct semantics of the returned array of IDs. - #39
Method Response#getHeaders() : array will now return a two-dimensional array with grouped values to support
multi-value headers. Previous versions returned a one-dimensional key-value array.
# Previous versions
[
'Status' => 'HTTP/2 200 OK',
'Set-Cookie' => 'tasty_cookie=strawberry',
]
# Since 3.0.0-alpha
[
'Status' => [
'HTTP/2 200 OK',
],
'Set-Cookie' => [
'yummy_cookie=choco',
'tasty_cookie=strawberry',
],
]
Method Response#getHeader(string $headerKey) : array will now return an array containing all values for the given
header key to support multi-value headers. Previous versions returned the last value as a string.
echo $response->getHeader('Set-Cookie');
# Previous versions
'tasty_cookie=strawberry'
# Since 3.0.0-alpha
[
'yummy_cookie=choco',
'tasty_cookie=strawberry'
]
Method Response#getRawResponse() : string is no longer available and its usage must be replaced with Response#getOutput().
The method was deprecated since version 2.6.0.
Response#getHeaderLine(string $headerKey) : string that returns all values, separated by comma, for the given key. - #35Response#getHeader(string $headerKey) : array and Response#getHeaderLine(string $headerKey) : string. - #35Response#getRawResponse() : string that was deprecated in version 2.6.0 in favour of Response#getOutput() : string. - #36stream_select returning false in case of a system call interrupt. - #41pm.max_children setting. - #40Two new methods to Response class - #27
Response#getOutput() which is identical to Response#getRawResponse() and will return the complete output from
the STDOUT stream of the response.Response#getError() which will return the complete output of the STDERR stream of the response.Second parameter $errorBuffer in tha pass through callback signature - #27
$callback = function( string $outputBuffer, string $errorBuffer ) {};
This parameter will contain the contents of the STDERR stream packets.
Response#getRawResponse() in favour of consistant naming. This method will be removed in v3.0.0 - #27ProcessManagerException that was introduced in v2.5.0 - #27
Please read this blog post why this (BC breaking) change was necessary
and how to handle server-sent errors now.bin/fcgiget to accept full URL paths and print STDOUT and STDERR outputNew ProcessManagerException in case the php-fpm responds with packages of type STDERR.
This refers mainly to the error Primary script unknown resp. the response File not found..
CI builds for PHP 7.3
20000 and was updated to 200000 as
recommended in the official PHP documentation. - #20php://input on worker side when client sends content larger than 65535 bytes - #15getHost() and getPort() with getSocketAddress() in interface hollodotme\FastCGI\Interfaces\ConfiguresSocketConnection - #9unix:// must be omitted for the first parameter of hollodotme\FastCGI\SocketConnections\UnixDomainSocketfsockopen() with stream_socket_client() for connecting to php-fpm. - #9addResponseCallbacks(callable ...$callbacks) to all request classes to enable response evaluation delegation - #6addFailureCallbacks(callable ...$callbacks) to all request classes to enable exception handling delegationreadResponse(int $requestId, ?int $timeoutMs = null) : ProvidesResponseData to read and retrieve a single responsereadResponses(?int $imeoutMs = null, int ...$requestIds) : \Generator to read and yield multiple responsesreadReadyResponses(?int $imeoutMs = null) : \Generator to check for ready responses, read and yield themwaitForResponses(?int $timeout = null) to Client class for waiting for multiple responses and calling the respective response callbacks - #5getRequestIdsHavingResponse() : array to enable reactive read of responses as they occurhasUnhandledResponses() : bool to check for outstanding responseshandleResponse(int $requestId, ?int $timeoutMs = null) to fetch a specific response and notify the respective response callbackhandleResponses(?int $timeoutMs = null, int ...$requestIds) to fetch a specific responses and notify the respective response callbackshandleReadyResponses(?int $timeoutMs = null) to check for ready responses, fetch them and notify the respective response callbackswaitForResponse(int $requestId, ?int $timeoutMs = null) is not returning a response anymore, but will call the response callbackreadResponse(int $requestId, ?int $timeoutMs = null): ProvidesResponseData if you want to get the response directly.sendRequest and sendAsyncRequest expect to get an object of interface hollodotme\FastCGI\Interfaces\ProvidesRequestData - #5sendRequest and waitForResponse now return an object of interface hollodotme\FastCGI\Interfaces\ProvidesResponseData - #2GET, POST, PUT, PATCH and DELETE in hollodotme\FastCGI\Constants\RequestMethod - #5HTTP/1.0 and HTTP/1.1 in hollodotme\FastCGI\Constants\ServerProtocol - #5hollodotme\FastCGI\Requests\GetRequesthollodotme\FastCGI\Requests\PostRequesthollodotme\FastCGI\Requests\PutRequesthollodotme\FastCGI\Requests\PatchRequesthollodotme\FastCGI\Requests\DeleteRequestClientEncoders\PacketEncoderSocketConnections\DefaultsBased on Pierrick Charron's PHP-FastCGI-Client:
ConfiguresSocketConnectionUnixDomainSocket and NetworkSocketFastCGIClientExceptionForbiddenException, ReadFailedException, TimeoutException, WriteFailedExceptionClient now expects a ConfiguresSocketConnection instanceClient->request() to Client->sendRequest()Client->async_request() to Client->sendAsyncRequest()Client->wait_for_response() to Client->waitForResponse()ClientClient (now part of the socket connection)Client->getValues()See CHANHGELOG
See CHANGELOG.
See CHANGELOG
See CHANGELOG
See CHANGELOG and please mind the BC break section
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG.
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG
See CHANGELOG.
See CHANGELOG
See CHANGELOG.
See CHANGELOG
How can I help you explore Laravel packages today?