| Type | Line | Description |
|---|---|---|
| getRawValues | 119 |
| Type | Line | Description |
|---|---|---|
| fail | 103 | param $cause [\Exception] the failure cause <b> this method is deprecated <s> fail($cause) </s> </b> Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed. param $failureMessage [string] the failure message <b> this method is deprecated <s> fail($failureMessage) </s> </b> |
| Type | Line | Description |
|---|---|---|
| tryFail | 156 | param $cause [\Exception] the failure cause <b> this method is deprecated <s> tryFail($cause) </s> </b> Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed. param $failureMessage [string] the failure message <b> this method is deprecated <s> tryFail($failureMessage) </s> </b> |
| Type | Line | Description |
|---|---|---|
| completer | 305 |
| Type | Line | Description |
|---|---|---|
| send | 110 | param $message [mixed] the message to send <b> this method is deprecated <s> send($message) </s> </b> Like @see \io\vertx\jphp\core\eventbus\MessageProducer::send but specifying a <code>replyHandler</code> that will be called if the recipient subsequently replies to the message. param $message [mixed] the message to send param $replyHandler [callable] reply handler will be called when any reply from the recipient is received, may be {@code null} <b> this method is deprecated <s> send($message, $replyHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| complete | 145 | <b> this method is deprecated <s> complete() </s> </b> Set the result. Any handler will be called, if there is one, and the future will be marked as completed. param $result [mixed] the result <b> this method is deprecated <s> complete($result) </s> </b> |
| Type | Line | Description |
|---|---|---|
| fail | 174 | param $cause [\Exception] the failure cause <b> this method is deprecated <s> fail($cause) </s> </b> Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed. param $failureMessage [string] the failure message <b> this method is deprecated <s> fail($failureMessage) </s> </b> |
| Type | Line | Description |
|---|---|---|
| tryComplete | 202 | <b> this method is deprecated <s> tryComplete() </s> </b> Set the failure. Any handler will be called, if there is one, and the future will be marked as completed. param $result [mixed] the result <b> this method is deprecated <s> tryComplete($result) </s> </b> |
| Type | Line | Description |
|---|---|---|
| tryFail | 231 | param $cause [\Exception] the failure cause <b> this method is deprecated <s> tryFail($cause) </s> </b> Try to set the failure. When it happens, any handler will be called, if there is one, and the future will be marked as completed. param $failureMessage [string] the failure message <b> this method is deprecated <s> tryFail($failureMessage) </s> </b> |
| Type | Line | Description |
|---|---|---|
| completer | 344 |
| Type | Line | Description |
|---|---|---|
| getNow | 471 | param $options [RequestOptions | array] the request options param $responseHandler [callable] the response handler <b> this method is deprecated <s> getNow($options, $responseHandler) </s> </b> Sends an HTTP GET request to the server at the default host and port, specifying a response handler to receive the response param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> getNow($requestURI, $responseHandler) </s> </b> Sends an HTTP GET request to the server at the specified host and default port, specifying a response handler to receive the response param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> getNow($host, $requestURI, $responseHandler) </s> </b> Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive the response param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> getNow($port, $host, $requestURI, $responseHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| headNow | 776 | param $options [RequestOptions | array] the request options param $responseHandler [callable] the response handler <b> this method is deprecated <s> headNow($options, $responseHandler) </s> </b> Sends an HTTP HEAD request to the server at the default host and port, specifying a response handler to receive the response param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> headNow($requestURI, $responseHandler) </s> </b> Sends an HTTP HEAD request to the server at the specified host and default port, specifying a response handler to receive the response param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> headNow($host, $requestURI, $responseHandler) </s> </b> Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive the response param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> headNow($port, $host, $requestURI, $responseHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| optionsNow | 960 | param $options [RequestOptions | array] the request options param $responseHandler [callable] the response handler <b> this method is deprecated <s> optionsNow($options, $responseHandler) </s> </b> Sends an HTTP OPTIONS request to the server at the default host and port, specifying a response handler to receive the response param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> optionsNow($requestURI, $responseHandler) </s> </b> Sends an HTTP OPTIONS request to the server at the specified host and default port, specifying a response handler to receive the response param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> optionsNow($host, $requestURI, $responseHandler) </s> </b> Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive the response param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $responseHandler [callable] the response handler <b> this method is deprecated <s> optionsNow($port, $host, $requestURI, $responseHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| websocketStream | 1970 | param $options [RequestOptions | array] the request options <b> this method is deprecated <s> websocketStream($options) </s> </b> Create a WebSocket stream at the relative request URI using the default host and port and the specified headers param $requestURI [string] the relative URI <b> this method is deprecated <s> websocketStream($requestURI) </s> </b> Create a WebSocket stream to the specified host, relative request URI and default port param $host [string] the host param $requestURI [string] the relative URI <b> this method is deprecated <s> websocketStream($host, $requestURI) </s> </b> Create a WebSocket stream with the specified options, and with the specified headers param $options [RequestOptions | array] the request options param $headers [MultiMap] the headers <b> this method is deprecated <s> websocketStream($options, $headers) </s> </b> Create a WebSocket stream at the relative request URI using the default host and port and the specified headers param $requestURI [string] the relative URI param $headers [MultiMap] the headers <b> this method is deprecated <s> websocketStream($requestURI, $headers) </s> </b> Create a WebSocket stream to the specified port, host and relative request URI param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI <b> this method is deprecated <s> websocketStream($port, $host, $requestURI) </s> </b> Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers <b> this method is deprecated <s> websocketStream($host, $requestURI, $headers) </s> </b> Create a WebSocket stream with the specified options, with the specified headers and using the specified version of WebSockets param $options [RequestOptions | array] the request options param $headers [MultiMap] the headers param $version [string] the websocket version <b> this method is deprecated <s> websocketStream($options, $headers, $version) </s> </b> Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version <b> this method is deprecated <s> websocketStream($requestURI, $headers, $version) </s> </b> Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers <b> this method is deprecated <s> websocketStream($port, $host, $requestURI, $headers) </s> </b> Create a WebSocket stream with the specified options and with the specified headers and using the specified version of WebSockets param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version <b> this method is deprecated <s> websocketStream($host, $requestURI, $headers, $version) </s> </b> Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols param $options [RequestOptions | array] the request options param $headers [MultiMap] the headers param $version [string] the websocket version param $subProtocols [string] the subprotocols to use <b> this method is deprecated <s> websocketStream($options, $headers, $version, $subProtocols) </s> </b> Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version param $subProtocols [string] the subprotocols <b> this method is deprecated <s> websocketStream($requestURI, $headers, $version, $subProtocols) </s> </b> Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version <b> this method is deprecated <s> websocketStream($port, $host, $requestURI, $headers, $version) </s> </b> Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version param $subProtocols [string] the subprotocols to use <b> this method is deprecated <s> websocketStream($host, $requestURI, $headers, $version, $subProtocols) </s> </b> Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols param $port [integer] the port param $host [string] the host param $requestURI [string] the relative URI param $headers [MultiMap] the headers param $version [string] the websocket version param $subProtocols [string] the subprotocols to use <b> this method is deprecated <s> websocketStream($port, $host, $requestURI, $headers, $version, $subProtocols) </s> </b> |
| Type | Line | Description |
|---|---|---|
| websocketStreamAbs | 1985 |
| Type | Line | Description |
|---|---|---|
| handler | 193 |
| Type | Line | Description |
|---|---|---|
| pause | 202 |
| Type | Line | Description |
|---|---|---|
| resume | 211 |
| Type | Line | Description |
|---|---|---|
| fetch | 221 |
| Type | Line | Description |
|---|---|---|
| endHandler | 231 |
| Type | Line | Description |
|---|---|---|
| isAuthorised | 50 |
| Type | Line | Description |
|---|---|---|
| refreshToken | 114 |
| Type | Line | Description |
|---|---|---|
| createKeycloak | 65 |
| Type | Line | Description |
|---|---|---|
| getToken | 135 |
| Type | Line | Description |
|---|---|---|
| decodeToken | 147 |
| Type | Line | Description |
|---|---|---|
| getScopeSeparator | 189 | The RFC 6749 states that a scope is expressed as a set of case-sensitive and space-delimited strings, however vendors tend not to agree on this and we see the following cases being used: space, plus sign, comma. |
| Type | Line | Description |
|---|---|---|
| isAuthorised | 50 |
| Type | Line | Description |
|---|---|---|
| update | 155 |
| Type | Line | Description |
|---|---|---|
| updateWithOptions | 183 |
| Type | Line | Description |
|---|---|---|
| replace | 213 |
| Type | Line | Description |
|---|---|---|
| replaceWithOptions | 243 |
| Type | Line | Description |
|---|---|---|
| remove | 466 |
| Type | Line | Description |
|---|---|---|
| removeWithOptions | 492 |
| Type | Line | Description |
|---|---|---|
| removeOne | 518 |
| Type | Line | Description |
|---|---|---|
| removeOneWithOptions | 544 |
| Type | Line | Description |
|---|---|---|
| update | 104 |
| Type | Line | Description |
|---|---|---|
| updateWithOptions | 128 |
| Type | Line | Description |
|---|---|---|
| replace | 152 |
| Type | Line | Description |
|---|---|---|
| replaceWithOptions | 176 |
| Type | Line | Description |
|---|---|---|
| remove | 331 |
| Type | Line | Description |
|---|---|---|
| removeWithOptions | 353 |
| Type | Line | Description |
|---|---|---|
| removeOne | 375 |
| Type | Line | Description |
|---|---|---|
| removeOneWithOptions | 397 |
| Type | Line | Description |
|---|---|---|
| setQueryTimeout | 249 | It can be over written at any time and becomes active on the next query call. |
| Type | Line | Description |
|---|---|---|
| getValidationFailureHandler | 107 |
| Type | Line | Description |
|---|---|---|
| setValidationFailureHandler | 119 |
| Type | Line | Description |
|---|---|---|
| setNotImplementedFailureHandler | 132 |
| Type | Line | Description |
|---|---|---|
| getValidationFailureHandler | 78 |
| Type | Line | Description |
|---|---|---|
| setValidationFailureHandler | 90 |
| Type | Line | Description |
|---|---|---|
| setNotImplementedFailureHandler | 103 |
| Type | Line | Description |
|---|---|---|
| UserSessionHandler | 33 | It requires that the session handler is already present on previous matching routes. It requires an Auth provider so, if the user is deserialized from a clustered session it knows which Auth provider to associate the session with. |
| Type | Line | Description |
|---|---|---|
| handle | 46 |
| Type | Line | Description |
|---|---|---|
| create | 57 |
| Type | Line | Description |
|---|---|---|
| language | 126 |
| Type | Line | Description |
|---|---|---|
| country | 136 |
| Type | Line | Description |
|---|---|---|
| variant | 146 |
| Type | Line | Description |
|---|---|---|
| Locale | 23 |
| Type | Line | Description |
|---|---|---|
| create | 70 | param $language [string] <b> this method is deprecated <s> create($language) </s> </b> param $language [string] param $country [string] <b> this method is deprecated <s> create($language, $country) </s> </b> param $language [string] param $country [string] param $variant [string] <b> this method is deprecated <s> create($language, $country, $variant) </s> </b> |
| Type | Line | Description |
|---|---|---|
| language | 80 |
| Type | Line | Description |
|---|---|---|
| country | 90 |
| Type | Line | Description |
|---|---|---|
| variant | 100 |
| Type | Line | Description |
|---|---|---|
| accept | 67 |
| Type | Line | Description |
|---|---|---|
| exceptionHandler | 440 |
| Type | Line | Description |
|---|---|---|
| acceptableLocales | 528 | When 2 or more entries have the same quality then the order used to return the best match is based on the lowest index on the original list. For example if a user has en-US and en-GB with same quality and this order the best match will be en-US because it was declared as first entry by the client. |
| Type | Line | Description |
|---|---|---|
| preferredLocale | 553 |
| Type | Line | Description |
|---|---|---|
| setExtension | 84 |
| Type | Line | Description |
|---|---|---|
| setExtension | 84 |
| Type | Line | Description |
|---|---|---|
| setExtension | 84 |
| Type | Line | Description |
|---|---|---|
| setExtension | 84 |
| Type | Line | Description |
|---|---|---|
| setExtension | 84 |
| Type | Line | Description |
|---|---|---|
| setExtension | 82 |
| Type | Line | Description |
|---|---|---|
| TemplateEngine | 27 | <p> Concrete implementations exist for several well-known template engines. |
| Type | Line | Description |
|---|---|---|
| AdminUtils | 25 |
| Type | Line | Description |
|---|---|---|
| create | 77 | param $vertx [Vertx] Vert.x instance to use param $zookeeperHosts [string] comma-separated list of Zookeeper server, e.g. localhost:2181,localhost:2182 <b> this method is deprecated <s> create($vertx, $zookeeperHosts) </s> </b> Create a new AdminUtils instance param $vertx [Vertx] Vert.x instance to use param $zookeeperHosts [string] comma-separated list of Zookeeper server, e.g. localhost:2181,localhost:2182 param $autoClose [boolean] If set to true, the client will auto-close the connection after a command <b> this method is deprecated <s> create($vertx, $zookeeperHosts, $autoClose) </s> </b> Create a new AdminUtils instance param $vertx [Vertx] Vert.x instance to use param $zookeeperHosts [string] comma-separated list of Zookeeper server, e.g. localhost:2181,localhost:2182 param $connectionTimeoutMs [integer] Maximum time in ms to wait for the client to connect to Zookeeper param $isSecure [boolean] If set to true, ZkUtils will perform security checks, i.e. ACL checks param $autoClose [boolean] If set to true, the client will auto-close the connection after a command <b> this method is deprecated <s> create($vertx, $zookeeperHosts, $connectionTimeoutMs, $isSecure, $autoClose) </s> </b> |
| Type | Line | Description |
|---|---|---|
| createTopic | 119 | param $topicName [string] Name of the to-be-created topic param $partitionCount [integer] Number of partitions param $replicationFactor [integer] Number of replicates. Must be lower or equal to the number of available Brokers param $completionHandler [callable] vert.x callback <b> this method is deprecated <s> createTopic($topicName, $partitionCount, $replicationFactor, $completionHandler) </s> </b> Creates a new Kafka topic on all Brokers managed by the given Zookeeper instance(s). In contrast to @see @see \io\vertx\jphp\kafka\admin\AdminUtils::createTopic, one can pass in additional configuration parameters as a map (String -> String). param $topicName [string] Name of the to-be-created topic param $partitionCount [integer] Number of partitions param $replicationFactor [integer] Number of replicates. Must be lower or equal to the number of available Brokers param $topicConfig [array] map with additional topic configuration parameters param $completionHandler [callable] vert.x callback <b> this method is deprecated <s> createTopic($topicName, $partitionCount, $replicationFactor, $topicConfig, $completionHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| deleteTopic | 131 |
| Type | Line | Description |
|---|---|---|
| topicExists | 143 |
| Type | Line | Description |
|---|---|---|
| changeTopicConfig | 157 |
| Type | Line | Description |
|---|---|---|
| close | 169 |
| Type | Line | Description |
|---|---|---|
| checksum | 75 |
| Type | Line | Description |
|---|---|---|
| basicConsume | 146 | param $queue [string] param $address [string] param $resultHandler [callable] <b> this method is deprecated <s> basicConsume($queue, $address, $resultHandler) </s> </b> Use @see \io\vertx\jphp\rabbitmq\RabbitMQClient::basicConsumer instead <p> Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag. param $queue [string] param $address [string] param $autoAck [boolean] param $resultHandler [callable] <b> this method is deprecated <s> basicConsume($queue, $address, $autoAck, $resultHandler) </s> </b> Use @see \io\vertx\jphp\rabbitmq\RabbitMQClient::basicConsumer instead <p> Start a non-nolocal, non-exclusive consumer, with a server-generated consumerTag and error handler param $queue [string] param $address [string] param $autoAck [boolean] param $resultHandler [callable] param $errorHandler [callable] <b> this method is deprecated <s> basicConsume($queue, $address, $autoAck, $resultHandler, $errorHandler) </s> </b> |
| Type | Line | Description |
|---|---|---|
| basicCancel | 185 |