In ssl.h rev. 1.144 2018/02/22 17:29:24, jsing@ provided SSL_up_ref(3).
authorschwarze <schwarze@openbsd.org>
Tue, 27 Feb 2018 02:33:05 +0000 (02:33 +0000)
committerschwarze <schwarze@openbsd.org>
Tue, 27 Feb 2018 02:33:05 +0000 (02:33 +0000)
Merge the documentation from OpenSSL.

lib/libssl/man/SSL_new.3

index cfe8b33..434cea0 100644 (file)
@@ -1,8 +1,9 @@
-.\"    $OpenBSD: SSL_new.3,v 1.2 2016/12/04 12:22:48 schwarze Exp $
-.\"    OpenSSL 9b86974e Aug 17 15:21:33 2015 -0400
+.\" $OpenBSD: SSL_new.3,v 1.3 2018/02/27 02:33:05 schwarze Exp $
+.\" full merge up to: OpenSSL 1c7ae3dd Mar 29 19:17:55 2017 +1000
 .\"
-.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
-.\" Copyright (c) 2000, 2001 The OpenSSL Project.  All rights reserved.
+.\" This file was written by Richard Levitte <levitte@openssl.org>
+.\" and Matt Caswell <matt@openssl.org>.
+.\" Copyright (c) 2000, 2016 The OpenSSL Project.  All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 4 2016 $
+.Dd $Mdocdate: February 27 2018 $
 .Dt SSL_NEW 3
 .Os
 .Sh NAME
-.Nm SSL_new
+.Nm SSL_new ,
+.Nm SSL_up_ref
 .Nd create a new SSL structure for a connection
 .Sh SYNOPSIS
 .In openssl/ssl.h
 .Ft SSL *
 .Fn SSL_new "SSL_CTX *ctx"
+.Ft int
+.Fn SSL_up_ref "SSL *ssl"
 .Sh DESCRIPTION
 .Fn SSL_new
 creates a new
@@ -67,6 +71,12 @@ The new structure inherits the settings of the underlying context
 .Fa ctx :
 connection method, options, verification settings,
 timeout settings.
+The reference count of the new structure is set to 1.
+.Pp
+.Fn SSL_up_ref
+increments the reference count of
+.Fa ssl
+by 1.
 .Sh RETURN VALUES
 The following return values can occur:
 .Bl -tag -width Ds
@@ -80,6 +90,9 @@ The return value points to an allocated
 .Vt SSL
 structure.
 .El
+.Pp
+.Fn SSL_up_ref
+returns 1 for success or 0 for failure.
 .Sh SEE ALSO
 .Xr ssl 3 ,
 .Xr SSL_clear 3 ,