Represents an HTTP connection.
HTTP/1.x connection provides an limited implementation, the following methods are implemented:
package |
Default |
---|
__construct()
close() : void
An HTTP/2 connection will send a frame before.
closeHandler( $arg0) : $this
callable
$this
a reference to this, so the API can be used fluently
exceptionHandler( $arg0) : $this
callable
$this
a reference to this, so the API can be used fluently
getWindowSize() : integer
integer
the current connection window size or {@code -1} for HTTP/1.x
goAway( $arg0, $arg1 = null, $arg2 = null) : $this
param $errorCode [integer] goAway($errorCode)
Like @see \io\vertx\jphp\core\http\HttpConnection::goAway with no buffer.
param $errorCode [integer] param $lastStreamId [integer] goAway($errorCode, $lastStreamId)
Send a go away frame to the remote endpoint of the connection.
errorCode
and debugData
lastStreamId
will be closed0
when all the remaining streams are closed this connection will be closed automaticallyThis is not implemented for HTTP/1.x.
param $errorCode [integer] the {@literal GOAWAY} error code param $lastStreamId [integer] the last stream id param $debugData [Buffer] additional debug data sent to the remote endpoint goAway($errorCode, $lastStreamId, $debugData)
integer
integer
Buffer
$this
goAwayHandler( $arg0) : $this
This is not implemented for HTTP/1.x.
callable
$this
a reference to this, so the API can be used fluently
indicatedServerName() : string
string
the indicated server name
isSsl() : boolean
boolean
true if this {@link io.vertx.core.http.HttpConnection} is encrypted via SSL/TLS.
localAddress() : \io\vertx\jphp\core\net\SocketAddress
ping( $arg0, $arg1) : $this
This is not implemented for HTTP/1.x.
Buffer
callable
$this
a reference to this, so the API can be used fluently
pingHandler( $arg0) : $this
This is not implemented for HTTP/1.x.
callable
$this
a reference to this, so the API can be used fluently
remoteAddress() : \io\vertx\jphp\core\net\SocketAddress
remoteSettings() : \io\vertx\jphp\core\http\Http2Settings
\io\vertx\jphp\core\http\Http2Settings
the current remote endpoint settings for this connection - this is not implemented for HTTP/1.x
remoteSettingsHandler( $arg0) : $this
This is not implemented for HTTP/1.x.
callable
$this
a reference to this, so the API can be used fluently
settings() : \io\vertx\jphp\core\http\Http2Settings
\io\vertx\jphp\core\http\Http2Settings
the latest server settings acknowledged by the remote endpoint - this is not implemented for HTTP/1.x
setWindowSize( $arg0) : $this
Increasing this value, gives better performance when several data streams are multiplexed
This is not implemented for HTTP/1.x.
integer
$this
a reference to this, so the API can be used fluently
shutdown( $arg0 = null) : $this
This is not implemented for HTTP/1.x.
shutdown()
Initiate a connection shutdown, a go away frame is sent and the connection is closed when all current streams
will be closed or the timeout
is fired.
This is not implemented for HTTP/1.x.
param $timeoutMs [integer] the timeout in milliseconds shutdown($timeoutMs)
integer
$this
a reference to this, so the API can be used fluently
shutdownHandler( $arg0) : $this
This is not implemented for HTTP/1.x.
callable
$this
a reference to this, so the API can be used fluently
updateSettings( $arg0, $arg1 = null) : $this
This is not implemented for HTTP/1.x.
param $settings [Http2Settings | array] the new settings updateSettings($settings)
Send to the remote endpoint an update of this endpoint settings
The completionHandler
will be notified when the remote endpoint has acknowledged the settings.
This is not implemented for HTTP/1.x.
param $settings [Http2Settings | array] the new settings param $completionHandler [callable] the handler notified when the settings have been acknowledged by the remote endpoint updateSettings($settings, $completionHandler)
array | Http2Settings
callable
$this
a reference to this, so the API can be used fluently