topics-map.php

<?php

/**
 * Symbol => topic slug, for a symbol whose docblock has no @topic yet (see BUILD.md). The slug is a topic of the
 * symbol's own project: content/<project>/topics/<slug>.md. It mirrors phasync.dev/TOPICS-DRAFT.md (the decided tables)
 * and must agree with it; a source @topic that disagrees with this map is reported by lint.
 */
return [
    // phasync
    'phasync' => 'coroutines',
    'phasync::run' => 'coroutines',
    'phasync::go' => 'coroutines',
    'phasync::await' => 'coroutines',
    'phasync::yield' => 'coroutines',
    'AggregateException' => 'coroutines',
    'RethrowExceptionInterface' => 'coroutines',
    'phasync::sleep' => 'waiting-and-timeouts',
    'phasync::readable' => 'waiting-and-timeouts',
    'phasync::writable' => 'waiting-and-timeouts',
    'phasync::awaitFlag' => 'waiting-and-timeouts',
    'phasync::raiseFlag' => 'waiting-and-timeouts',
    'SelectableInterface' => 'waiting-and-timeouts',
    'TimeoutException' => 'waiting-and-timeouts',
    'IOException' => 'waiting-and-timeouts',
    'phasync::cancel' => 'cancellation-and-cleanup',
    'phasync::throw' => 'cancellation-and-cleanup',
    'phasync::finally' => 'cancellation-and-cleanup',
    'CancelledException' => 'cancellation-and-cleanup',
    'phasync::channel' => 'channels-and-messaging',
    'phasync::publisher' => 'channels-and-messaging',
    'ChannelException' => 'channels-and-messaging',
    'ReadChannelInterface' => 'channels-and-messaging',
    'WriteChannelInterface' => 'channels-and-messaging',
    'SubscribersInterface' => 'channels-and-messaging',
    'SubscriberInterface' => 'channels-and-messaging',
    'Queue' => 'channels-and-messaging',
    'QueueInterface' => 'channels-and-messaging',
    'WaitGroup' => 'coordination-and-limits',
    'Synchronized' => 'coordination-and-limits',
    'RateLimiter' => 'coordination-and-limits',
    'LockInterface' => 'coordination-and-limits',
    'LockTrait' => 'coordination-and-limits',
    'Event' => 'coordination-and-limits',
    'Pool' => 'resource-management',
    'LruCache' => 'resource-management',
    'BufferedStream' => 'streams-and-files',
    'UnbufferedStream' => 'streams-and-files',
    'StringStream' => 'streams-and-files',
    'StringBuffer' => 'streams-and-files',
    'MultipartStream' => 'streams-and-files',
    'MultipartStreamInterface' => 'streams-and-files',
    'UploadedFile' => 'streams-and-files',
    'HttpClient' => 'http-client',
    'HttpClientOptions' => 'http-client',
    'Request' => 'http-client',
    'Response' => 'http-client',
    'CurlResponse' => 'http-client',
    'Uri' => 'http-client',
    'ClientException' => 'http-client',
    'NetworkException' => 'http-client',
    'RequestException' => 'http-client',
    'Process' => 'processes',
    'ProcessInterface' => 'processes',
    'ProcessRunner' => 'processes',
    'Console' => 'console-and-logging',
    'ConsoleLogger' => 'console-and-logging',
    'sleep' => 'blocking-calls-and-the-extension',
    'file_get_contents' => 'blocking-calls-and-the-extension',
    'file_put_contents' => 'blocking-calls-and-the-extension',
    'flock' => 'blocking-calls-and-the-extension',
    'ensure_loaded' => 'blocking-calls-and-the-extension',
    'phasync::service' => 'the-event-loop',
    'phasync::isRunning' => 'the-event-loop',
    'phasync::getLoop' => 'the-event-loop',
    'phasync::getFiber' => 'the-event-loop',
    'PollerInterface' => 'the-event-loop',
    // Swerve
    'Swerve' => 'request-handlers',
    'ServerInterface' => 'request-handlers',
    // ServerRequest: the only public one is phasync\Psr\ServerRequest (phasync, http-client); Swerve has none, so it is not mapped here
    'StaticFiles' => 'request-handlers',
    'WebSocket' => 'websockets-and-sse',
    'Swerve::publish' => 'coordination-across-workers',
    'Swerve::subscribe' => 'coordination-across-workers',
    'Swerve::claim' => 'coordination-across-workers',
    'OrderedChannel' => 'coordination-across-workers',
    'Subscription' => 'coordination-across-workers',
    'SubscriberLagException' => 'coordination-across-workers',
    'SealedObject' => 'coordination-across-workers',
    'Claim' => 'coordination-across-workers',
    'Swerve::cache' => 'resource-management',
    'Cache' => 'resource-management',
    'CacheKeyException' => 'resource-management',
    'Swerve::log' => 'production',
    'Swerve::setLog' => 'production',
    'Swerve::onShutdown' => 'production',
    'Swerve::awaitShutdown' => 'production',
    'Swerve::draining' => 'production',
    'Swerve::getVersion' => 'production',
];