Below, is a summary of all classes and their parameters's typehinting status. .
Method | Argument | Typehint | Default | |||||
interface Endpoint | ||||||||
Method | Argument | Typehint | Default | |||||
send | Promise | |||||||
broadcast | Promise | |||||||
multicast | Promise | |||||||
sendBinary | Promise | |||||||
broadcastBinary | Promise | |||||||
multicastBinary | Promise | |||||||
close | ||||||||
getInfo | array | |||||||
getClients | array | |||||||
class Handshake | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
setStatus | Response | |||||||
setReason | Response | |||||||
addHeader | Response | |||||||
setHeader | Response | |||||||
write | \Amp\Promise | |||||||
flush | ||||||||
end | \Amp\Promise | |||||||
setCookie | Response | |||||||
push | Response | |||||||
state | int | |||||||
handshake | ||||||||
class Message | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
isBinary | bool | |||||||
class Rfc6455Endpoint | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
send | Promise | |||||||
sendBinary | Promise | |||||||
broadcast | Promise | |||||||
broadcastBinary | Promise | |||||||
multicast | Promise | |||||||
multicastBinary | Promise | |||||||
close | ||||||||
getInfo | array | |||||||
getClients | array | |||||||
class Rfc6455Gateway | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
setOption | ||||||||
__invoke | ||||||||
do | \Generator | |||||||
reapClient | Rfc6455Client | |||||||
read | \Generator | |||||||
onAppError | \Generator | |||||||
doClose | \Generator | |||||||
sendCloseFrame | Promise | |||||||
tryAppOnOpen | \Generator | |||||||
tryAppOnData | \Generator | |||||||
tryAppOnClose | \Generator | |||||||
unloadClient | ||||||||
onParsedControlFrame | ||||||||
onParsedData | ||||||||
onParsedError | ||||||||
compile | string | |||||||
write | Promise | |||||||
send | Promise | |||||||
doSend | \Generator | |||||||
broadcast | Promise | |||||||
multicast | Promise | |||||||
close | ||||||||
getInfo | array | |||||||
getClients | array | |||||||
update | Promise | |||||||
sendHeartbeatPing | ||||||||
timeout | ||||||||
parser | \Generator | |||||||
monitor | array | |||||||
class BodyParser | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
onResolve | ||||||||
end | ParsedBody | |||||||
read | Promise | |||||||
stream | FieldBody | |||||||
initField | ||||||||
updateFieldSize | bool | |||||||
error | ||||||||
initIncremental | \Generator | |||||||
interface Bootable | ||||||||
Method | Argument | Typehint | Default | |||||
boot | ||||||||
class CommandClient | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
socketPath | ||||||||
send | Promise | |||||||
connect | \Generator | |||||||
parser | \Generator | |||||||
__destruct | ||||||||
restart | Promise | |||||||
stop | Promise | |||||||
started | Promise | |||||||
importServerSockets | Promise | |||||||
class Console | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
output | ||||||||
forceAnsiOn | ||||||||
isArgDefined | ||||||||
getArg | ||||||||
parseArgs | ||||||||
class ConsoleLogger | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
setAnsiColorOption | ||||||||
output | ||||||||
class DebugProcess | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
doStart | \Generator | |||||||
doStop | \Generator | |||||||
class FieldBody | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
getMetadata | Promise | |||||||
class Host | ||||||||
Method | Argument | Typehint | Default | |||||
expose | Host | |||||||
name | Host | |||||||
use | Host | |||||||
encrypt | Host | |||||||
separateIPv4Binding | bool | |||||||
export | array | |||||||
class HPack | ||||||||
Method | Argument | Typehint | Default | |||||
init | ||||||||
huffman_lookup_init | ||||||||
huffman_decode | ||||||||
huffman_codes_init | ||||||||
huffman_lens_init | ||||||||
huffman_encode | ||||||||
decode_dynamic_integer | ||||||||
table_resize | ||||||||
decode | ||||||||
encode_dynamic_integer | ||||||||
encode | ||||||||
class Http1Driver | ||||||||
Method | Argument | Typehint | Default | |||||
setup | ||||||||
filters | array | |||||||
writer | \Generator | |||||||
upgradeBodySize | ||||||||
parser | \Generator | |||||||
responseInitFilter | ||||||||
chunkedResponseFilter | \Generator | |||||||
class Http2Driver | ||||||||
Method | Argument | Typehint | Default | |||||
setup | ||||||||
filters | array | |||||||
responseInitFilter | ||||||||
dispatchInternalRequest | ||||||||
writer | \Generator | |||||||
writeData | ||||||||
tryDataSend | ||||||||
writePing | ||||||||
writeFrame | ||||||||
upgradeBodySize | ||||||||
parser | \Generator | |||||||
interface HttpDriver | ||||||||
Method | Argument | Typehint | Default | |||||
setup | ||||||||
filters | array | |||||||
writer | \Generator | |||||||
upgradeBodySize | ||||||||
parser | \Generator | |||||||
class IpcLogger | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
output | ||||||||
onWritable | ||||||||
onDeadIpcSock | ||||||||
flush | ||||||||
class Logger | ||||||||
Method | Argument | Typehint | Default | |||||
output | ||||||||
emergency | ||||||||
alert | ||||||||
critical | ||||||||
error | ||||||||
warning | ||||||||
notice | ||||||||
info | ||||||||
debug | ||||||||
log | ||||||||
format | ||||||||
ansify | ||||||||
canEmit | ||||||||
setOutputLevel | ||||||||
setAnsify | ||||||||
interface Middleware | ||||||||
Method | Argument | Typehint | Default | |||||
do | ||||||||
interface Monitor | ||||||||
Method | Argument | Typehint | Default | |||||
monitor | array | |||||||
class NullBody | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
class Options | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
__get | ||||||||
__set | ||||||||
setDebug | ||||||||
setUser | ||||||||
setMaxConnections | ||||||||
setConnectionsPerIP | ||||||||
setMaxRequestsPerConnection | ||||||||
setConnectionTimeout | ||||||||
setDefaultContentType | ||||||||
setDefaultTextCharset | ||||||||
setSendServerToken | ||||||||
setSocketBacklogSize | ||||||||
setNormalizeMethodCase | ||||||||
setMaxInputVars | ||||||||
setMaxFieldLen | ||||||||
setMaxBodySize | ||||||||
setMaxHeaderSize | ||||||||
setSoftStreamCap | ||||||||
setMaxConcurrentStreams | ||||||||
setMaxFramesPerSecond | ||||||||
setIoGranularity | ||||||||
setAllowedMethods | ||||||||
setDeflateEnable | ||||||||
setDeflateContentTypes | ||||||||
setDeflateMinimumLength | ||||||||
setDeflateBufferSize | ||||||||
setChunkBufferSize | ||||||||
setOutputBufferSize | ||||||||
setShutdownTimeout | ||||||||
setConfigPath | ||||||||
class ParsedBody | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
get | ||||||||
getArray | array | |||||||
getMetadata | ||||||||
getMetadataArray | array | |||||||
getNames | array | |||||||
getAll | array | |||||||
class Process | ||||||||
Method | Argument | Typehint | Default | |||||
doStart | \Generator | |||||||
doStop | \Generator | |||||||
__construct | ||||||||
start | \Generator | |||||||
stop | \Generator | |||||||
registerSignalHandler | ||||||||
registerShutdownHandler | ||||||||
registerErrorHandler | ||||||||
exit | ||||||||
interface Request | ||||||||
Method | Argument | Typehint | Default | |||||
getMethod | string | |||||||
getUri | string | |||||||
getProtocolVersion | string | |||||||
getHeader | ||||||||
getHeaderArray | array | |||||||
getAllHeaders | array | |||||||
getBody | \Amp\ByteStream\Message | |||||||
getParam | ||||||||
getParamArray | array | |||||||
getAllParams | array | |||||||
getCookie | ||||||||
getLocalVar | ||||||||
setLocalVar | ||||||||
getConnectionInfo | array | |||||||
getOption | ||||||||
interface Response | ||||||||
Method | Argument | Typehint | Default | |||||
setStatus | Response | |||||||
setReason | Response | |||||||
addHeader | Response | |||||||
setHeader | Response | |||||||
setCookie | Response | |||||||
write | \Amp\Promise | |||||||
flush | ||||||||
end | \Amp\Promise | |||||||
push | Response | |||||||
state | int | |||||||
class Root | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
__invoke | ||||||||
removeDotPathSegments | string | |||||||
fetchCachedStat | ||||||||
shouldBufferContent | ||||||||
respondWithLookup | \Generator | |||||||
lookup | \Generator | |||||||
coalesceIndexPath | \Generator | |||||||
respond | ||||||||
checkPreconditions | int | |||||||
doNonRangeResponse | ||||||||
assignCommonHeaders | ||||||||
selectMimeTypeFromPath | string | |||||||
normalizeByteRanges | ||||||||
doRangeResponse | \Generator | |||||||
finalizeResponse | \Generator | |||||||
sendNonRange | \Generator | |||||||
sendSingleRange | \Generator | |||||||
sendMultiRange | \Generator | |||||||
setOption | ||||||||
setIndexes | ||||||||
setUseEtagInode | ||||||||
setExpiresPeriod | ||||||||
loadMimeFileTypes | ||||||||
setMimeTypes | ||||||||
setDefaultMimeType | ||||||||
setDefaultTextCharset | ||||||||
setUseAggressiveCacheHeaders | ||||||||
setAggressiveCacheMultiplier | ||||||||
setCacheEntryTtl | ||||||||
setCacheEntryMaxCount | ||||||||
setBufferedFileMaxCount | ||||||||
setBufferedFileMaxSize | ||||||||
update | \Amp\Promise | |||||||
class Router | ||||||||
Method | Argument | Typehint | Default | |||||
setOption | ||||||||
__invoke | ||||||||
do | ||||||||
use | ||||||||
prefix | ||||||||
cacheDispatchResult | ||||||||
route | Router | |||||||
boot | ||||||||
bootRouteTarget | array | |||||||
update | Promise | |||||||
buildRouter | ||||||||
monitor | array | |||||||
class Server | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
state | int | |||||||
getOption | ||||||||
setOption | ||||||||
attach | ||||||||
detach | ||||||||
notify | Promise | |||||||
start | Promise | |||||||
createHttpDriverHandlers | ||||||||
doStart | \Generator | |||||||
generateBindableAddressContextMap | array | |||||||
onAcceptable | ||||||||
onUnixSocketAcceptable | ||||||||
negotiateCrypto | ||||||||
failCryptoNegotiation | ||||||||
stop | Promise | |||||||
doStop | \Generator | |||||||
importClient | ||||||||
writeResponse | ||||||||
onResponseDataDone | ||||||||
onWritable | ||||||||
timeoutKeepAlives | ||||||||
renewConnectionTimeout | ||||||||
clearConnectionTimeout | ||||||||
onReadable | ||||||||
onParsedMessage | ||||||||
onParsedEntityHeaders | ||||||||
onParsedEntityPart | ||||||||
onParsedMessageWithEntity | ||||||||
onEntitySizeWarning | ||||||||
onParseError | ||||||||
setTrace | ||||||||
respond | ||||||||
sendPreAppServiceUnavailableResponse | ||||||||
sendPreAppInvalidHostResponse | ||||||||
sendPreAppMethodNotAllowedResponse | ||||||||
sendPreAppTraceResponse | ||||||||
sendPreAppOptionsResponse | ||||||||
tryApplication | ||||||||
initializeResponse | Response | |||||||
onApplicationError | ||||||||
tryFilterErrorResponse | ||||||||
tryErrorResponse | ||||||||
close | ||||||||
clear | ||||||||
export | \Closure | |||||||
dropPrivileges | ||||||||
logDebug | ||||||||
__debugInfo | ||||||||
monitor | array | |||||||
interface ServerObserver | ||||||||
Method | Argument | Typehint | Default | |||||
update | \Amp\Promise | |||||||
class StandardRequest | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
getMethod | string | |||||||
getUri | string | |||||||
getProtocolVersion | string | |||||||
getHeader | ||||||||
getHeaderArray | array | |||||||
getAllHeaders | array | |||||||
getBody | Message | |||||||
getParam | ||||||||
getParamArray | array | |||||||
getAllParams | array | |||||||
parseParams | ||||||||
getCookie | ||||||||
getLocalVar | ||||||||
setLocalVar | ||||||||
getConnectionInfo | array | |||||||
getOption | ||||||||
class StandardResponse | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
__debugInfo | array | |||||||
setStatus | Response | |||||||
setReason | Response | |||||||
isValidReasonPhrase | bool | |||||||
addHeader | Response | |||||||
isValidHeaderField | bool | |||||||
isValidHeaderValue | bool | |||||||
setHeader | Response | |||||||
setCookie | Response | |||||||
write | \Amp\Promise | |||||||
flush | ||||||||
end | \Amp\Promise | |||||||
setCookies | ||||||||
push | Response | |||||||
state | int | |||||||
class Ticker | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
update | Promise | |||||||
use | ||||||||
updateTime | ||||||||
tryUseCallback | ||||||||
class Vhost | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
addInterface | ||||||||
getIds | array | |||||||
getInterfaces | array | |||||||
getBindableAddresses | array | |||||||
getName | string | |||||||
getApplication | callable | |||||||
getPorts | array | |||||||
getHttpDriver | ||||||||
hasName | bool | |||||||
isEncrypted | bool | |||||||
setCrypto | ||||||||
parseNamesFromTlsCertArray | array | |||||||
normalizeTlsCryptoMethod | array | |||||||
hasAlpnSupport | bool | |||||||
getTlsContextArr | array | |||||||
getFilters | array | |||||||
__toString | string | |||||||
__debugInfo | array | |||||||
monitor | array | |||||||
class VhostContainer | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
use | ||||||||
preventCryptoSocketConflict | ||||||||
addHttpDriver | ||||||||
setupHttpDrivers | ||||||||
selectHttpDriver | ||||||||
selectHost | ||||||||
getBindableAddresses | array | |||||||
getTlsBindingsByAddress | array | |||||||
count | ||||||||
__debugInfo | ||||||||
monitor | array | |||||||
class WatcherProcess | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
collectProcessGarbage | ||||||||
doStart | \Generator | |||||||
checkCommands | ||||||||
bindCommandServer | ||||||||
acceptCommand | \Generator | |||||||
replyCommand | ||||||||
readCommand | \Generator | |||||||
parseWorkerAddrCtx | ||||||||
recommendAssertionSetting | ||||||||
recommendLogLevel | ||||||||
determineWorkerCount | ||||||||
canReusePort | ||||||||
countCpuCores | ||||||||
bindIpcServer | ||||||||
accept | \Generator | |||||||
read | \Generator | |||||||
onDeadIpcClient | ||||||||
generateWorkerCommand | string | |||||||
spawn | Promise | |||||||
restart | ||||||||
doStop | \Generator | |||||||
interface Websocket | ||||||||
Method | Argument | Typehint | Default | |||||
onStart | ||||||||
onHandshake | ||||||||
onOpen | ||||||||
onData | ||||||||
onClose | ||||||||
onStop | ||||||||
class WorkerProcess | ||||||||
Method | Argument | Typehint | Default | |||||
__construct | ||||||||
doStart | \Generator | |||||||
doStop | \Generator | |||||||
exit |