[jira] [Updated] (TS-542) API: Update documentation for "Txn" and "Ssn" data API changes and additions

["James Peach (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/TS-542?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

James Peach updated TS-542:
---------------------------

    Component/s: TS API
    
> API: Update documentation for "Txn" and "Ssn" data  API changes and additions
> -----------------------------------------------------------------------------
>
>                 Key: TS-542
>                 URL: https://issues.apache.org/jira/browse/TS-542
>             Project: Traffic Server
>          Issue Type: Improvement
>          Components: Documentation, TS API
>            Reporter: Leif Hedstrom
>             Fix For: Doc 3.0
>
>
> I've modified and augmented the APIs for handling TXN (and now Sessions / SSN) private data. The two existing APIs have changed names (and prototypes), and there are a few additional APIs. See the "diffs" below for a brief description of what the changes. As for usage, the intent is still the same, to have per transaciton and per session plugin data, that can be shared across plugins (and in the case with the SSN data, shared between multiple transactions on the same sessions).
> -  tsapi int TSHttpTxnGetMaxArgCnt(void);
> -  tsapi TSReturnCode TSHttpTxnSetArg(TSHttpTxn txnp, int arg_idx, void *arg);
> -  tsapi TSReturnCode TSHttpTxnGetArg(TSHttpTxn txnp, int arg_idx, void **arg);
> +
> +  tsapi TSReturnCode TSHttpTxnArgSet(TSHttpTxn txnp, int arg_idx, void *arg);
> +  tsapi TSReturnCode TSHttpTxnArgGet(TSHttpTxn txnp, int arg_idx, void **arg);
> +  tsapi TSReturnCode TSHttpSsnArgSet(TSHttpSsn ssnp, int arg_idx, void *arg);
> +  tsapi TSReturnCode TSHttpSsnArgGet(TSHttpSsn ssnp, int arg_idx, void **arg);
> +
> +  /* The reserve API should only be use in TSAPI plugins, during plugin initialization! */
> +  /* The lookup methods can be used anytime, but are best used during initialization as well,
> +     or at least "cache" the results for best performance. */
> +  tsapi TSReturnCode TSHttpArgIndexReserve(const char* name, const char* description, int* arg_idx);
> +  tsapi TSReturnCode TSHttpArgIndexNameLookup(const char* name, int* arg_idx, const char** description);
> +  tsapi TSReturnCode TSHttpArgIndexLookup(int arg_idx, const char** name, const char** description);
> +
> +  /** @deprecated */
> +  tsapi TS_DEPRECATED int TSHttpTxnMaxArgCntGet(void);

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira