openssl-prebuild/linux_amd64/ssl/share/doc/openssl/html/man3/BIO_s_socket.html
2020-03-02 16:50:34 +00:00

87 lines
2.7 KiB
HTML
Executable File

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>BIO_s_socket</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#notes">NOTES</a></li>
<li><a href="#return_values">RETURN VALUES</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<hr />
<h1><a name="name">NAME</a></h1>
<p>BIO_s_socket, BIO_new_socket - socket BIO</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
#include &lt;openssl/bio.h&gt;</pre>
<pre>
const BIO_METHOD *BIO_s_socket(void);</pre>
<pre>
BIO *BIO_new_socket(int sock, int close_flag);</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><code>BIO_s_socket()</code> returns the socket BIO method. This is a wrapper
round the platform's socket routines.</p>
<p><code>BIO_read_ex()</code> and <code>BIO_write_ex()</code> read or write the underlying socket.
<code>BIO_puts()</code> is supported but <code>BIO_gets()</code> is not.</p>
<p>If the close flag is set then the socket is shut down and closed
when the BIO is freed.</p>
<p><code>BIO_new_socket()</code> returns a socket BIO using <strong>sock</strong> and <strong>close_flag</strong>.</p>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p>Socket BIOs also support any relevant functionality of file descriptor
BIOs.</p>
<p>The reason for having separate file descriptor and socket BIOs is that on some
platforms sockets are not file descriptors and use distinct I/O routines,
Windows is one such platform. Any code mixing the two will not work on
all platforms.</p>
<p>
</p>
<hr />
<h1><a name="return_values">RETURN VALUES</a></h1>
<p><code>BIO_s_socket()</code> returns the socket BIO method.</p>
<p><code>BIO_new_socket()</code> returns the newly allocated BIO or NULL is an error
occurred.</p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.</p>
<p>Licensed under the Apache License 2.0 (the &quot;License&quot;). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
</body>
</html>