doc/man3/TS_RESP_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 TS_RESP_CTX_new_ex, TS_RESP_CTX_new,
   6 TS_RESP_CTX_free - Timestamp response context object creation
   7
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ts.h>
  12
  13  TS_RESP_CTX *TS_RESP_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
  14  TS_RESP_CTX *TS_RESP_CTX_new(void);
  15  void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
  16
  17 =head1 DESCRIPTION
  18
  19 Creates a response context that can be used for generating responses.
  20
  21 TS_RESP_CTX_new_ex() allocates and initializes a TS_RESP_CTX structure with a
  22 library context of I<libctx> and a property query of I<propq>.
  23 The library context and property query can be used to select which providers
  24 supply the fetched algorithms.
  25
  26 TS_RESP_CTX_new() is similar to TS_RESP_CTX_new_ex() but sets the library context
  27 and property query to NULL. This results in the default (NULL) library context
  28 being used for any operations requiring algorithm fetches.
  29
  30 TS_RESP_CTX_free() frees the B<TS_RESP_CTX> object I<ctx>.
  31
  32 =head1 RETURN VALUES
  33
  34 If the allocation fails, TS_RESP_CTX_new_ex() and TS_RESP_CTX_new() return NULL,
  35 otherwise it returns a pointer to the newly allocated structure.
  36
  37 =head1 HISTORY
  38
  39 The function TS_RESP_CTX_new_ex() was added in OpenSSL 3.0.
  40
  41 =head1 COPYRIGHT
  42
  43 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
  44
  45 Licensed under the Apache License 2.0 (the "License").  You may not use
  46 this file except in compliance with the License.  You can obtain a copy
  47 in the file LICENSE in the source distribution or at
  48 L<https://www.openssl.org/source/license.html>.
  49
  50 =cut