409 lines
18 KiB
Groff
Executable File
409 lines
18 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "DEFINE_STACK_OF 3"
|
|
.TH DEFINE_STACK_OF 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
DEFINE_STACK_OF, DEFINE_STACK_OF_CONST, DEFINE_SPECIAL_STACK_OF,
|
|
DEFINE_SPECIAL_STACK_OF_CONST,
|
|
sk_TYPE_num, sk_TYPE_value, sk_TYPE_new, sk_TYPE_new_null,
|
|
sk_TYPE_reserve, sk_TYPE_free, sk_TYPE_zero, sk_TYPE_delete,
|
|
sk_TYPE_delete_ptr, sk_TYPE_push, sk_TYPE_unshift, sk_TYPE_pop,
|
|
sk_TYPE_shift, sk_TYPE_pop_free, sk_TYPE_insert, sk_TYPE_set,
|
|
sk_TYPE_find, sk_TYPE_find_ex, sk_TYPE_sort, sk_TYPE_is_sorted,
|
|
sk_TYPE_dup, sk_TYPE_deep_copy, sk_TYPE_set_cmp_func, sk_TYPE_new_reserve
|
|
\&\- stack container
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/safestack.h>
|
|
\&
|
|
\& STACK_OF(TYPE)
|
|
\& DEFINE_STACK_OF(TYPE)
|
|
\& DEFINE_STACK_OF_CONST(TYPE)
|
|
\& DEFINE_SPECIAL_STACK_OF(FUNCTYPE, TYPE)
|
|
\& DEFINE_SPECIAL_STACK_OF_CONST(FUNCTYPE, TYPE)
|
|
\&
|
|
\& typedef int (*sk_TYPE_compfunc)(const TYPE *const *a, const TYPE *const *b);
|
|
\& typedef TYPE * (*sk_TYPE_copyfunc)(const TYPE *a);
|
|
\& typedef void (*sk_TYPE_freefunc)(TYPE *a);
|
|
\&
|
|
\& int sk_TYPE_num(const STACK_OF(TYPE) *sk);
|
|
\& TYPE *sk_TYPE_value(const STACK_OF(TYPE) *sk, int idx);
|
|
\& STACK_OF(TYPE) *sk_TYPE_new(sk_TYPE_compfunc compare);
|
|
\& STACK_OF(TYPE) *sk_TYPE_new_null(void);
|
|
\& int sk_TYPE_reserve(STACK_OF(TYPE) *sk, int n);
|
|
\& void sk_TYPE_free(const STACK_OF(TYPE) *sk);
|
|
\& void sk_TYPE_zero(const STACK_OF(TYPE) *sk);
|
|
\& TYPE *sk_TYPE_delete(STACK_OF(TYPE) *sk, int i);
|
|
\& TYPE *sk_TYPE_delete_ptr(STACK_OF(TYPE) *sk, TYPE *ptr);
|
|
\& int sk_TYPE_push(STACK_OF(TYPE) *sk, const TYPE *ptr);
|
|
\& int sk_TYPE_unshift(STACK_OF(TYPE) *sk, const TYPE *ptr);
|
|
\& TYPE *sk_TYPE_pop(STACK_OF(TYPE) *sk);
|
|
\& TYPE *sk_TYPE_shift(STACK_OF(TYPE) *sk);
|
|
\& void sk_TYPE_pop_free(STACK_OF(TYPE) *sk, sk_TYPE_freefunc freefunc);
|
|
\& int sk_TYPE_insert(STACK_OF(TYPE) *sk, TYPE *ptr, int idx);
|
|
\& TYPE *sk_TYPE_set(STACK_OF(TYPE) *sk, int idx, const TYPE *ptr);
|
|
\& int sk_TYPE_find(STACK_OF(TYPE) *sk, TYPE *ptr);
|
|
\& int sk_TYPE_find_ex(STACK_OF(TYPE) *sk, TYPE *ptr);
|
|
\& void sk_TYPE_sort(const STACK_OF(TYPE) *sk);
|
|
\& int sk_TYPE_is_sorted(const STACK_OF(TYPE) *sk);
|
|
\& STACK_OF(TYPE) *sk_TYPE_dup(const STACK_OF(TYPE) *sk);
|
|
\& STACK_OF(TYPE) *sk_TYPE_deep_copy(const STACK_OF(TYPE) *sk,
|
|
\& sk_TYPE_copyfunc copyfunc,
|
|
\& sk_TYPE_freefunc freefunc);
|
|
\& sk_TYPE_compfunc (*sk_TYPE_set_cmp_func(STACK_OF(TYPE) *sk,
|
|
\& sk_TYPE_compfunc compare));
|
|
\& STACK_OF(TYPE) *sk_TYPE_new_reserve(sk_TYPE_compfunc compare, int n);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
Applications can create and use their own stacks by placing any of the macros
|
|
described below in a header file. These macros define typesafe inline
|
|
functions that wrap around the utility \fBOPENSSL_sk_\fR \s-1API\s0.
|
|
In the description here, \fB\f(BI\s-1TYPE\s0\fB\fR is used
|
|
as a placeholder for any of the OpenSSL datatypes, such as \fBX509\fR.
|
|
.PP
|
|
\&\s-1\fISTACK_OF\s0()\fR returns the name for a stack of the specified \fB\f(BI\s-1TYPE\s0\fB\fR.
|
|
\&\s-1\fIDEFINE_STACK_OF\s0()\fR creates set of functions for a stack of \fB\f(BI\s-1TYPE\s0\fB\fR. This
|
|
will mean that type \fB\f(BI\s-1TYPE\s0\fB\fR is stored in each stack, the type is referenced by
|
|
\&\fB\s-1STACK_OF\s0\fR(\fB\f(BI\s-1TYPE\s0\fB\fR) and each function name begins with \fBsk_\f(BI\s-1TYPE\s0\fB_\fR.
|
|
For example:
|
|
.PP
|
|
.Vb 1
|
|
\& TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
|
|
.Ve
|
|
.PP
|
|
\&\s-1\fIDEFINE_STACK_OF_CONST\s0()\fR is identical to \s-1\fIDEFINE_STACK_OF\s0()\fR except
|
|
each element is constant. For example:
|
|
.PP
|
|
.Vb 1
|
|
\& const TYPE *sk_TYPE_value(STACK_OF(TYPE) *sk, int idx);
|
|
.Ve
|
|
.PP
|
|
\&\s-1\fIDEFINE_SPECIAL_STACK_OF\s0()\fR defines a stack of \fB\f(BI\s-1TYPE\s0\fB\fR but
|
|
each function uses \fB\s-1FUNCNAME\s0\fR in the function name. For example:
|
|
.PP
|
|
.Vb 1
|
|
\& TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
|
|
.Ve
|
|
.PP
|
|
\&\s-1\fIDEFINE_SPECIAL_STACK_OF_CONST\s0()\fR is similar except that each element is
|
|
constant:
|
|
.PP
|
|
.Vb 1
|
|
\& const TYPE *sk_FUNCNAME_value(STACK_OF(TYPE) *sk, int idx);
|
|
.Ve
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_num\fR() returns the number of elements in \fIsk\fR or \-1 if \fIsk\fR is
|
|
\&\s-1NULL\s0.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_value\fR() returns element \fIidx\fR in \fIsk\fR, where \fIidx\fR starts at
|
|
zero. If \fIidx\fR is out of range then \s-1NULL\s0 is returned.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_new\fR() allocates a new empty stack using comparison function
|
|
\&\fIcompare\fR. If \fIcompare\fR is \s-1NULL\s0 then no comparison function is used. This
|
|
function is equivalent to \fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR(\fIcompare\fR, 0).
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_new_null\fR() allocates a new empty stack with no comparison
|
|
function. This function is equivalent to \fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR(\s-1NULL\s0, 0).
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_reserve\fR() allocates additional memory in the \fIsk\fR structure
|
|
such that the next \fIn\fR calls to \fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_push\fR()
|
|
or \fBsk_\f(BI\s-1TYPE\s0\fB_unshift\fR() will not fail or cause memory to be allocated
|
|
or reallocated. If \fIn\fR is zero, any excess space allocated in the
|
|
\&\fIsk\fR structure is freed. On error \fIsk\fR is unchanged.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR() allocates a new stack. The new stack will have
|
|
additional memory allocated to hold \fIn\fR elements if \fIn\fR is positive.
|
|
The next \fIn\fR calls to \fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_push\fR() or
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_unshift\fR() will not fail or cause memory to be allocated or
|
|
reallocated. If \fIn\fR is zero or less than zero, no memory is allocated.
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR() also sets the comparison function \fIcompare\fR
|
|
to the newly created stack. If \fIcompare\fR is \s-1NULL\s0 then no comparison
|
|
function is used.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_set_cmp_func\fR() sets the comparison function of \fIsk\fR to
|
|
\&\fIcompare\fR. The previous comparison function is returned or \s-1NULL\s0 if there
|
|
was no previous comparison function.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_free\fR() frees up the \fIsk\fR structure. It does \fInot\fR free up any
|
|
elements of \fIsk\fR. After this call \fIsk\fR is no longer valid.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_zero\fR() sets the number of elements in \fIsk\fR to zero. It does not
|
|
free \fIsk\fR so after this call \fIsk\fR is still valid.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_pop_free\fR() frees up all elements of \fIsk\fR and \fIsk\fR itself. The
|
|
free function \fIfreefunc()\fR is called on each element to free it.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_delete\fR() deletes element \fIi\fR from \fIsk\fR. It returns the deleted
|
|
element or \s-1NULL\s0 if \fIi\fR is out of range.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_delete_ptr\fR() deletes element matching \fIptr\fR from \fIsk\fR. It
|
|
returns the deleted element or \s-1NULL\s0 if no element matching \fIptr\fR was found.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR() inserts \fIptr\fR into \fIsk\fR at position \fIidx\fR. Any
|
|
existing elements at or after \fIidx\fR are moved downwards. If \fIidx\fR is out
|
|
of range the new element is appended to \fIsk\fR. \fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR() either
|
|
returns the number of elements in \fIsk\fR after the new element is inserted or
|
|
zero if an error (such as memory allocation failure) occurred.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_push\fR() appends \fIptr\fR to \fIsk\fR it is equivalent to:
|
|
.PP
|
|
.Vb 1
|
|
\& sk_TYPE_insert(sk, ptr, \-1);
|
|
.Ve
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_unshift\fR() inserts \fIptr\fR at the start of \fIsk\fR it is equivalent
|
|
to:
|
|
.PP
|
|
.Vb 1
|
|
\& sk_TYPE_insert(sk, ptr, 0);
|
|
.Ve
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_pop\fR() returns and removes the last element from \fIsk\fR.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_shift\fR() returns and removes the first element from \fIsk\fR.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_set\fR() sets element \fIidx\fR of \fIsk\fR to \fIptr\fR replacing the current
|
|
element. The new element value is returned or \s-1NULL\s0 if an error occurred:
|
|
this will only happen if \fIsk\fR is \s-1NULL\s0 or \fIidx\fR is out of range.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() searches \fIsk\fR for the element \fIptr\fR. In the case
|
|
where no comparison function has been specified, the function performs
|
|
a linear search for a pointer equal to \fIptr\fR. The index of the first
|
|
matching element is returned or \fB\-1\fR if there is no match. In the case
|
|
where a comparison function has been specified, \fIsk\fR is sorted then
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() returns the index of a matching element or \fB\-1\fR if there
|
|
is no match. Note that, in this case, the matching element returned is
|
|
not guaranteed to be the first; the comparison function will usually
|
|
compare the values pointed to rather than the pointers themselves and
|
|
the order of elements in \fIsk\fR could change.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_find_ex\fR() operates like \fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() except when a
|
|
comparison function has been specified and no matching element is found.
|
|
Instead of returning \fB\-1\fR, \fBsk_\f(BI\s-1TYPE\s0\fB_find_ex\fR() returns the index of the
|
|
element either before or after the location where \fIptr\fR would be if it were
|
|
present in \fIsk\fR.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_sort\fR() sorts \fIsk\fR using the supplied comparison function.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_is_sorted\fR() returns \fB1\fR if \fIsk\fR is sorted and \fB0\fR otherwise.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_dup\fR() returns a copy of \fIsk\fR. Note the pointers in the copy
|
|
are identical to the original.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_deep_copy\fR() returns a new stack where each element has been
|
|
copied. Copying is performed by the supplied \fIcopyfunc()\fR and freeing by
|
|
\&\fIfreefunc()\fR. The function \fIfreefunc()\fR is only called if an error occurs.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
Care should be taken when accessing stacks in multi-threaded environments.
|
|
Any operation which increases the size of a stack such as \fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR()
|
|
or \fBsk_\f(BI\s-1TYPE\s0\fB_push\fR() can \*(L"grow\*(R" the size of an internal array and cause race
|
|
conditions if the same stack is accessed in a different thread. Operations such
|
|
as \fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_sort\fR() can also reorder the stack.
|
|
.PP
|
|
Any comparison function supplied should use a metric suitable
|
|
for use in a binary search operation. That is it should return zero, a
|
|
positive or negative value if \fIa\fR is equal to, greater than
|
|
or less than \fIb\fR respectively.
|
|
.PP
|
|
Care should be taken when checking the return values of the functions
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_find_ex\fR(). They return an index to the
|
|
matching element. In particular \fB0\fR indicates a matching first element.
|
|
A failed search is indicated by a \fB\-1\fR return value.
|
|
.PP
|
|
\&\s-1\fISTACK_OF\s0()\fR, \s-1\fIDEFINE_STACK_OF\s0()\fR, \s-1\fIDEFINE_STACK_OF_CONST\s0()\fR, and
|
|
\&\s-1\fIDEFINE_SPECIAL_STACK_OF\s0()\fR are implemented as macros.
|
|
.PP
|
|
The underlying utility \fBOPENSSL_sk_\fR \s-1API\s0 should not be used directly.
|
|
It defines these functions: \fIOPENSSL_sk_deep_copy()\fR,
|
|
\&\fIOPENSSL_sk_delete()\fR, \fIOPENSSL_sk_delete_ptr()\fR, \fIOPENSSL_sk_dup()\fR,
|
|
\&\fIOPENSSL_sk_find()\fR, \fIOPENSSL_sk_find_ex()\fR, \fIOPENSSL_sk_free()\fR,
|
|
\&\fIOPENSSL_sk_insert()\fR, \fIOPENSSL_sk_is_sorted()\fR, \fIOPENSSL_sk_new()\fR,
|
|
\&\fIOPENSSL_sk_new_null()\fR, \fIOPENSSL_sk_num()\fR, \fIOPENSSL_sk_pop()\fR,
|
|
\&\fIOPENSSL_sk_pop_free()\fR, \fIOPENSSL_sk_push()\fR, \fIOPENSSL_sk_reserve()\fR,
|
|
\&\fIOPENSSL_sk_set()\fR, \fIOPENSSL_sk_set_cmp_func()\fR, \fIOPENSSL_sk_shift()\fR,
|
|
\&\fIOPENSSL_sk_sort()\fR, \fIOPENSSL_sk_unshift()\fR, \fIOPENSSL_sk_value()\fR,
|
|
\&\fIOPENSSL_sk_zero()\fR.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_num\fR() returns the number of elements in the stack or \fB\-1\fR if the
|
|
passed stack is \s-1NULL\s0.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_value\fR() returns a pointer to a stack element or \s-1NULL\s0 if the
|
|
index is out of range.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_new\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_new_null\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR()
|
|
return an empty stack or \s-1NULL\s0 if an error occurs.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_reserve\fR() returns \fB1\fR on successful allocation of the required
|
|
memory or \fB0\fR on error.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_set_cmp_func\fR() returns the old comparison function or \s-1NULL\s0 if
|
|
there was no old comparison function.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_free\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_zero\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_pop_free\fR() and
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_sort\fR() do not return values.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_pop\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_shift\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_delete\fR() and
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_delete_ptr\fR() return a pointer to the deleted element or \s-1NULL\s0
|
|
on error.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_insert\fR(), \fBsk_\f(BI\s-1TYPE\s0\fB_push\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_unshift\fR() return
|
|
the total number of elements in the stack and 0 if an error occurred.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_set\fR() returns a pointer to the replacement element or \s-1NULL\s0 on
|
|
error.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_find\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_find_ex\fR() return an index to the found
|
|
element or \fB\-1\fR on error.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_is_sorted\fR() returns \fB1\fR if the stack is sorted and \fB0\fR if it is
|
|
not.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_dup\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_deep_copy\fR() return a pointer to the copy
|
|
of the stack.
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
Before OpenSSL 1.1.0, this was implemented via macros and not inline functions
|
|
and was not a public \s-1API\s0.
|
|
.PP
|
|
\&\fBsk_\f(BI\s-1TYPE\s0\fB_reserve\fR() and \fBsk_\f(BI\s-1TYPE\s0\fB_new_reserve\fR() were added in OpenSSL
|
|
1.1.1.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|