{"$schema":"https://yii2-framework.github.io/docs/reference/reference.schema.json","schemaVersion":1,"package":"road-runner","title":"RoadRunner","repository":"https://github.com/yii2-extensions/road-runner","ref":"main","commit":"68124de679830b7c1b9b50b49226af5bab68b847","generatedAt":"2026-10-18","url":"https://yii2-framework.github.io/docs/extensions/road-runner/reference/","types":{"yii2\\extensions\\roadrunner\\ResponseBody":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/road-runner/reference/responsebody/","summary":"Retains failures from streaming `read()` and `eof()` calls that an emitter may consume.","implements":["Psr\\Http\\Message\\StreamInterface"],"methods":{"__construct":{"signature":"public function __construct(Psr\\Http\\Message\\StreamInterface $stream)","params":[{"name":"$stream","type":"Psr\\Http\\Message\\StreamInterface"}]},"__toString":{"signature":"public function __toString(): string","return":{"type":"string"}},"close":{"signature":"public function close(): void","return":{"type":"void"}},"detach":{"signature":"public function detach(): resource|null","return":{"type":"resource|null"}},"eof":{"signature":"public function eof(): bool","return":{"type":"bool"}},"getContents":{"signature":"public function getContents(): string","return":{"type":"string"}},"getFailure":{"signature":"public function getFailure(): Throwable|null","summary":"Returns the failure even when the emitter returned normally after consuming it.","return":{"type":"Throwable|null"}},"getMetadata":{"signature":"public function getMetadata(string|null $key = null): mixed","params":[{"name":"$key","type":"string|null","default":"null","optional":true}],"return":{"type":"mixed"}},"getSize":{"signature":"public function getSize(): int|null","return":{"type":"int|null"}},"isReadable":{"signature":"public function isReadable(): bool","return":{"type":"bool"}},"isSeekable":{"signature":"public function isSeekable(): bool","return":{"type":"bool"}},"isWritable":{"signature":"public function isWritable(): bool","return":{"type":"bool"}},"read":{"signature":"public function read(int $length): string","params":[{"name":"$length","type":"int"}],"return":{"type":"string"}},"rewind":{"signature":"public function rewind(): void","return":{"type":"void"}},"seek":{"signature":"public function seek(int $offset, int $whence = \\yii2\\extensions\\roadrunner\\SEEK_SET): void","params":[{"name":"$offset","type":"int"},{"name":"$whence","type":"int","default":"\\yii2\\extensions\\roadrunner\\SEEK_SET","optional":true}],"return":{"type":"void"}},"tell":{"signature":"public function tell(): int","return":{"type":"int"}},"write":{"signature":"public function write(string $string): int","params":[{"name":"$string","type":"string"}],"return":{"type":"int"}}}},"yii2\\extensions\\roadrunner\\RoadRunner":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/road-runner/reference/roadrunner/","summary":"Runs the RoadRunner request loop for a Yii PSR bridge application.","methods":{"__construct":{"signature":"public function __construct(yii2\\extensions\\psrbridge\\http\\Application $app)","summary":"Creates a new instance of the `yii2\\extensions\\roadrunner\\RoadRunner` class.","params":[{"name":"$app","type":"yii2\\extensions\\psrbridge\\http\\Application","description":"PSR bridge application instance."}]},"run":{"signature":"public function run(): int","summary":"Processes requests from the configured `yii2\\extensions\\psrbridge\\http\\Application` instance until the worker returns `null`.","return":{"type":"int","description":"Exit code indicating successful execution (`yii2\\extensions\\psrbridge\\http\\ServerExitCode::OK`)."},"throws":[{"type":"Throwable","description":"When streaming, worker transport, or application finalization fails."}]}}}}}