maskit commented on code in PR #12790: URL: https://github.com/apache/trafficserver/pull/12790#discussion_r2742894555
########## doc/developer-guide/api/functions/TSVConnClientHelloGet.en.rst: ########## @@ -0,0 +1,50 @@ +.. Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed + with this work for additional information regarding copyright + ownership. The ASF licenses this file to you under the Apache + License, Version 2.0 (the "License"); you may not use this file + except in compliance with the License. You may obtain a copy of + the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + +.. include:: ../../../common.defs + +.. default-domain:: cpp + +TSVConnClientHelloGet +********************* + +Synopsis +======== + +.. code-block:: cpp + + #include <ts/ts.h> + +.. function:: TSClientHello TSVConnClientHelloGet(TSVConn sslp) +.. function:: void TSClientHelloDestroy(TSClientHello ch) +.. function:: TSReturnCode TSClientHelloExtensionGet(TSClientHello ch, unsigned int type, const unsigned char **out, size_t *outlen) + +Description +=========== + +:func:`TSVConnClientHelloGet` retrieves ClientHello message data from the TLS +virtual connection :arg:`sslp`. This function is typically called from the Review Comment: Since we don't deep copy the information, we can use this function only on limited hooks. I'm sure we can use `TS_EVENT_SSL_CLIENT_HELLO`, but I'm not sure if it's the only hook or there are other hooks. The documentation should list up all the hook, or tell that `TS_EVENT_SSL_CLIENT_HELLO` is the only hook supported (maybe for now, until somebody confirms another hook work as well). -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
