Swerve

Examples

Every example by topic, with the page it belongs to.

Request handlers#

• ClientRequest – Read the request, write the response
• ClientRequest
• ClientRequest::sendResponseHeaders – An interim 103 and a final 201
• ClientRequest::flush – Put the head on the wire before the work
• ClientRequest::sendFile – Send part of a file
• ClientRequest::end – Trailers after a chunked body
• HeadersSentException – A status after the body began
• FormBody – The fields of a url-encoded form
• FormBody::for – Which requests have a form
• FormBody::files – An uploaded file
• FormBody::input – The raw bytes after parsing
• RequestBody – Read a body as it arrives
• RequestHandler – Hello, world
• RequestHandler
• ServerInterface
• StaticFiles – Files, and the application for the rest
• StaticFiles
• StaticFiles::__construct
• StaticFiles::wrap – Ranges, revalidation, and no PHP sources
• Swerve – Messages and the cache within one process
• Swerve

WebSockets and SSE#

• ServerSentEvents – An event stream
• ServerSentEvents
• ServerSentEvents::lastEventId – Resume after the last event seen
• ServerSentEvents::send – Event names, ids and retry
• ServerSentEvents::send
• ServerSentEvents::comment – Keep-alive comments
• WebSocket – An echo server
• WebSocket
• WebSocket
• WebSocket::from – Listen to messages, push from a subscription
• WebSocket::from
• WebSocket::accept – Read with receive() and close yourself
• WebSocket::accept
• WebSocket::handshake – Decisions for four requests
• WebSocket::upgrade – An adapter's upgrade
• WebSocket::run – After a 101 of your own
• WebSocket::receive
• WebSocket::send
• WebSocket::sendBinary – A binary message
• WebSocket::sendBinary
• WebSocket::end – A close code of your own
• WebSocket::end
• WebSocketHandshake – Accepted and refused

Coordination across workers#

• Claim – Two handles on one name
• Claim
• Claim
• Claim::acquire – Wait for the holder to finish
• Claim::acquire
• Claim::release – Release before the handle goes
• OrderedChannel – One order for every subscriber
• OrderedChannel
• OrderedChannel::write – Nothing is kept without a subscriber
• OrderedChannel::write
• OrderedChannel::subscribe
• OrderedChannel::getIterator – Subscribe at the foreach
• SubscriberLagException – A subscriber that fell behind
• SubscriberLagException
• Subscription – A subscription ends with its last reference
• Subscription
• Subscription::getIterator
• Swerve::publish – Every subscriber gets every message
• Swerve::publish
• Swerve::publishRaw – A WebSocket handler forwards binary frames to the other workers
• Swerve::publishRaw
• Swerve::subscribe – What a subscriber receives for each kind of value
• Swerve::subscribe – A heartbeat for keep-alives
• Swerve::subscribe
• Swerve::claim – Only one runs the report
• Swerve::claim
• SealedObject – A read-only message
• SealedObject
• SealedObject::seal – Seal a decoded value

Resource management#

• Cache – Set, get and expire values
• Cache
• Cache::get
• Cache::getMultiple
• Cache::has – A stored null and a missing key
• Cache::set
• Cache::setMultiple – Several values with one ttl
• Cache::delete – Delete one key, or several
• Cache::clear – Empty the cache
• CacheKeyException – Keys the cache refuses
• CacheKeyException
• Swerve::cache – Load once, then read from the cache
• Swerve::cache

Production#

• StopReason – Tell the client why
• Swerve::log – The logger before swerve sets one
• Swerve::log
• Swerve::setLog – Log through a PSR-3 logger of your own
• Swerve::setLog
• Swerve::draining – False while serving, true once the drain begins
• Swerve::draining
• Swerve::onShutdown – Close a WebSocket with a reason when the server stops
• Swerve::onShutdown
• Swerve::awaitShutdown – Wait with a timeout
• Swerve::awaitShutdown
• Swerve::ini
• Swerve::onWorkerStart
• Swerve::getVersion – The installed version
• WorkerStoppingException – Clean up when the worker stops