Skip to content

feat: allow passing parameters to the PHP callback and accessing its return value#1881

Merged
withinboredom merged 4 commits intoadd/modular-threadsfrom
feat/modular-threads-improved
Sep 17, 2025
Merged

feat: allow passing parameters to the PHP callback and accessing its return value#1881
withinboredom merged 4 commits intoadd/modular-threadsfrom
feat/modular-threads-improved

Conversation

@dunglas
Copy link
Member

@dunglas dunglas commented Sep 16, 2025 •
edited
Loading

Usage:

import (
	"net/http"
	"net/url"

	"github.com/dunglas/frankenphp"
)

var w = &worker{
	messages: make(chan message),
}

func init() {
	frankenphp.RegisterExternalWorker(w)
}

type worker struct {
	messages chan message
}

func (w *worker) Name() string {
	return "m#MyWorker"
}

func (w *worker) FileName() string {
	return "worker.php"
}

func (w *worker) GetMinThreads() int {
	return 1
}

func (w *worker) ThreadActivatedNotification(int)   {}
func (w *worker) ThreadDrainNotification(int)       {}
func (w *worker) ThreadDeactivatedNotification(int) {}
func (w *worker) Env() frankenphp.PreparedEnv {
	return frankenphp.PreparedEnv{}
}

var u = &url.URL{Host: "my-service.alt", Path: "/my-service"}

func (w *worker) ProvideRequest() *frankenphp.WorkerRequest[map[string]string, map[string]string] {
	m := <-w.messages

	return &frankenphp.WorkerRequest{
		Request: &http.Request{URL: u}},
		CallbackParameters: m.request,
		AfterFunc: func(callbackReturn map[string]string) {
			m.responseChan <- callbackReturn
		},
	}
}
<?php

// Handler outside the loop for better performance (doing less work)
$handler = static function (array $request): array  {
	// Do something with the request

    return ['message' => "Hello, {$request['Name']}"];
};

$maxRequests = (int)($_SERVER['MAX_REQUESTS'] ?? 0);
for ($nbRequests = 0; !$maxRequests || $nbRequests < $maxRequests; ++$nbRequests) {
    $keepRunning = \frankenphp_handle_request($handler);

    // Call the garbage collector to reduce the chances of it being triggered in the middle of the handling of a request
    gc_collect_cycles();

    if (!$keepRunning) {
      break;
    }
}

withinboredom
withinboredom approved these changes Sep 16, 2025
View reviewed changes
@dunglas
Copy link
Member Author

dunglas commented Sep 16, 2025

I added generics support, which way cleaner.

@withinboredom
Copy link
Member

withinboredom commented Sep 16, 2025

TIL that generics are allowed on structs... 😍

@withinboredom
Copy link
Member

withinboredom commented Sep 17, 2025

Is this one ready to merge @dunglas?

@dunglas
Copy link
Member Author

dunglas commented Sep 17, 2025

Yes!

alexandre-daubois
alexandre-daubois approved these changes Sep 17, 2025
View reviewed changes
Copy link
Member

@alexandre-daubois alexandre-daubois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM otherwise 🙂

@withinboredom withinboredom merged commit eab9194 into add/modular-threads Sep 17, 2025
@withinboredom withinboredom deleted the feat/modular-threads-improved branch September 17, 2025 09:51
dunglas added a commit that referenced this pull request Sep 18, 2025
@withinboredom @dunglas
feat: custom workers initial support (#1795)
52df300 
* create a simple thread framework

Signed-off-by: Robert Landers <[email protected]>

* add tests

Signed-off-by: Robert Landers <[email protected]>

* fix comment

Signed-off-by: Robert Landers <[email protected]>

* remove mention of an old function that no longer exists

Signed-off-by: Robert Landers <[email protected]>

* simplify providing a request

Signed-off-by: Robert Landers <[email protected]>

* satisfy linter

Signed-off-by: Robert Landers <[email protected]>

* add error handling and handle shutdowns

Signed-off-by: Robert Landers <[email protected]>

* add tests

Signed-off-by: Robert Landers <[email protected]>

* pipes are tied to workers, not threads

Signed-off-by: Robert Landers <[email protected]>

* fix test

Signed-off-by: Robert Landers <[email protected]>

* add a way to detect when a request is completed

Signed-off-by: Robert Landers <[email protected]>

* we never shutdown workers or remove them, so we do not need this

Signed-off-by: Robert Landers <[email protected]>

* add more comments

Signed-off-by: Robert Landers <[email protected]>

* Simplify modular threads (#1874)

* Simplify

* remove unused variable

* log thread index

* feat: allow passing parameters to the PHP callback and accessing its return value (#1881)

* fix formatting

Signed-off-by: Robert Landers <[email protected]>

* fix test compilation

Signed-off-by: Robert Landers <[email protected]>

* fix segfaults

Signed-off-by: Robert Landers <[email protected]>

* Update frankenphp.c

Co-authored-by: Kévin Dunglas <[email protected]>

---------

Signed-off-by: Robert Landers <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@withinboredom withinboredom withinboredom approved these changes

@alexandre-daubois alexandre-daubois alexandre-daubois approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dunglas @withinboredom @alexandre-daubois