Traffic Server
  1. Traffic Server
  2. TS-542

API: Update documentation for "Txn" and "Ssn" data API changes and additions

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: Docs
    • Component/s: Documentation, TS API
    • Labels:
      None

      Description

      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);

        Activity

        Leif Hedstrom created issue -
        Hide
        Leif Hedstrom added a comment -

        Moving these all to a "Doc 3.x" release version.

        Show
        Leif Hedstrom added a comment - Moving these all to a "Doc 3.x" release version.
        Leif Hedstrom made changes -
        Field Original Value New Value
        Fix Version/s Doc 3.x [ 12316472 ]
        Fix Version/s 3.0.0 [ 12314754 ]
        James Peach made changes -
        Summary Update documentation for "Txn" and "Ssn" data API changes and additions API: Update documentation for "Txn" and "Ssn" data API changes and additions
        James Peach made changes -
        Component/s TS API [ 12313111 ]
        Leif Hedstrom made changes -
        Fix Version/s Doc 3.4 [ 12323541 ]
        Fix Version/s Doc 3.0 [ 12316472 ]
        Leif Hedstrom made changes -
        Fix Version/s Docs [ 12324773 ]
        Fix Version/s Doc 3.4 [ 12323541 ]
        Leif Hedstrom made changes -
        Assignee Jon Sime [ jsime ]

          People

          • Assignee:
            Jon Sime
            Reporter:
            Leif Hedstrom
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development