You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@trafficserver.apache.org by GitBox <gi...@apache.org> on 2022/12/14 16:12:44 UTC
[GitHub] [trafficserver] brbzull0 opened a new pull request, #9251: Update TS API docs for RPC handling.
brbzull0 opened a new pull request, #9251:
URL: https://github.com/apache/trafficserver/pull/9251
Update the api docs. It seems there were missing some fields in the docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficserver] brbzull0 merged pull request #9251: Update TS API docs for RPC handling.
Posted by GitBox <gi...@apache.org>.
brbzull0 merged PR #9251:
URL: https://github.com/apache/trafficserver/pull/9251
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficserver] randall commented on a diff in pull request #9251: Update TS API docs for RPC handling.
Posted by GitBox <gi...@apache.org>.
randall commented on code in PR #9251:
URL: https://github.com/apache/trafficserver/pull/9251#discussion_r1050984965
##########
doc/developer-guide/api/functions/TSRPCRegister.en.rst:
##########
@@ -96,27 +107,49 @@ Description
We will provide binary compatibility within the lifespan of a major release.
+:arg:`provider_name` should be a string with the Plugin's descriptor. A null terminated string is expected.
+
+:arg:`provider_len` should be the length of the provider string..
+
:arg:`yamlcpp_lib_version` should be a string with the yaml-cpp library version
the plugin is using. A null terminated string is expected.
-:arg:`provider_name` should be a string with the Plugin's descriptor. A null terminated string is expected.
+:arg:`yamlcpp_lib_len` should be the length of the yamlcpp_lib_len string.
:c:func:`TSRPCRegisterMethodHandler` Add new registered method handler to the JSON RPC engine.
+
:arg:`name` call name to be exposed by the RPC Engine, this should match the incoming request.
If you register **get_stats** then the incoming jsonrpc call should have this very
same name in the **method** field. .. {...'method': 'get_stats'...}.
-:arg:`callback` The function to be registered. Check :c:func:`TSRPCMethodCb`. :arg:`info` TSRPCProviderHandle pointer,
+
+:arg:`name_len` The length of the name string.
+
+:arg:`callback` The function to be registered. Check :c:func:`TSRPCMethodCb`.
+
+:arg:`info` TSRPCProviderHandle pointer,
this will be used to provide more context information about this call. It is expected to use the one created by ``TSRPCRegister``.
+:arg:`opt` Pointer to `TSRPCHandlerOptions`` object. This will be used to store specifics about a particular call, the rpc
+manager will use this object to perform certain actions. A copy of this object wil be stored by the rpc manager.
Review Comment:
spelling: will not wil
##########
doc/developer-guide/api/functions/TSRPCRegister.en.rst:
##########
@@ -96,27 +107,49 @@ Description
We will provide binary compatibility within the lifespan of a major release.
+:arg:`provider_name` should be a string with the Plugin's descriptor. A null terminated string is expected.
+
+:arg:`provider_len` should be the length of the provider string..
+
:arg:`yamlcpp_lib_version` should be a string with the yaml-cpp library version
the plugin is using. A null terminated string is expected.
-:arg:`provider_name` should be a string with the Plugin's descriptor. A null terminated string is expected.
+:arg:`yamlcpp_lib_len` should be the length of the yamlcpp_lib_len string.
:c:func:`TSRPCRegisterMethodHandler` Add new registered method handler to the JSON RPC engine.
+
:arg:`name` call name to be exposed by the RPC Engine, this should match the incoming request.
If you register **get_stats** then the incoming jsonrpc call should have this very
same name in the **method** field. .. {...'method': 'get_stats'...}.
-:arg:`callback` The function to be registered. Check :c:func:`TSRPCMethodCb`. :arg:`info` TSRPCProviderHandle pointer,
+
+:arg:`name_len` The length of the name string.
+
+:arg:`callback` The function to be registered. Check :c:func:`TSRPCMethodCb`.
+
+:arg:`info` TSRPCProviderHandle pointer,
this will be used to provide more context information about this call. It is expected to use the one created by ``TSRPCRegister``.
+:arg:`opt` Pointer to `TSRPCHandlerOptions`` object. This will be used to store specifics about a particular call, the rpc
+manager will use this object to perform certain actions. A copy of this object wil be stored by the rpc manager.
+
Please check :ref:`jsonrpc_development` for examples.
:c:func:`TSRPCRegisterNotificationHandler` Add new registered method handler to the JSON RPC engine.
+
:arg:`name` call name to be exposed by the RPC Engine, this should match the incoming request.
If you register **get_stats** then the incoming jsonrpc call should have this very
same name in the **method** field. .. {...'method': 'get_stats'...}.
-:arg:`callback` The function to be registered. Check :c:func:`TSRPCNotificationCb`. :arg:`info` TSRPCProviderHandle pointer,
+
+:arg:`name_len` The length of the name string.
+
+:arg:`callback` The function to be registered. Check :c:func:`TSRPCNotificationCb`.
+
+:arg:`info` TSRPCProviderHandle pointer,
this will be used to provide more context information about this call. It is expected to use the one created by ``TSRPCRegister``.
+:arg:`opt` Pointer to `TSRPCHandlerOptions`` object. This will be used to store specifics about a particular call, the rpc
+manager will use this object to perform certain actions. A copy of this object wil be stored by the rpc manager.
Review Comment:
spelling: will not wil
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@trafficserver.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org