openssl/doc/man3/BIO_s_socket.pod

=pod

=head1 NAME

BIO_s_socket, BIO_new_socket - socket BIO

=head1 SYNOPSIS

 #include <openssl/bio.h>

 const BIO_METHOD *BIO_s_socket(void);

 BIO *BIO_new_socket(int sock, int close_flag);

=head1 DESCRIPTION

BIO_s_socket() returns the socket BIO method. This is a wrapper
round the platform's socket routines.

BIO_read_ex() and BIO_write_ex() read or write the underlying socket.
BIO_puts() is supported but BIO_gets() is not.

If the close flag is set then the socket is shut down and closed
when the BIO is freed.

BIO_new_socket() returns a socket BIO using B<sock> and B<close_flag>.

=head1 NOTES

Socket BIOs also support any relevant functionality of file descriptor
BIOs.

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.

=head1 RETURN VALUES

BIO_s_socket() returns the socket BIO method.

BIO_new_socket() returns the newly allocated BIO or NULL is an error
occurred.

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  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
L<https://www.openssl.org/source/license.html>.

=cut
Docs for socket BIO. 2000-09-14 00:05:50 +00:00			`=pod`

			`=head1 NAME`

BIO_seed() and BIO_tell() were documented in two other documents, which is redundant. They are now in their own document. Also, in the name section, all the functions described shoud be enumerated. This will also make it much simpler to generate softlinks name like each function to man-pages containing the info. 2000-09-14 20:24:56 +00:00			`BIO_s_socket, BIO_new_socket - socket BIO`
Docs for socket BIO. 2000-09-14 00:05:50 +00:00
			`=head1 SYNOPSIS`

			`#include <openssl/bio.h>`

RT4660: BIO_METHODs should be const. BIO_new, etc., don't need a non-const BIO_METHOD. This allows all the built-in method tables to live in .rodata. Reviewed-by: Richard Levitte <levitte@openssl.org> 2016-03-19 16:32:14 +00:00			`const BIO_METHOD *BIO_s_socket(void);`
Docs for socket BIO. 2000-09-14 00:05:50 +00:00
			`BIO *BIO_new_socket(int sock, int close_flag);`

			`=head1 DESCRIPTION`

Initial connect BIO docs. 2000-09-14 12:44:34 +00:00			`BIO_s_socket() returns the socket BIO method. This is a wrapper`
Docs for socket BIO. 2000-09-14 00:05:50 +00:00			`round the platform's socket routines.`

Document the new BIO functions introduced as part of the size_t work Reviewed-by: Richard Levitte <levitte@openssl.org> 2016-10-20 08:56:18 +00:00			`BIO_read_ex() and BIO_write_ex() read or write the underlying socket.`
Docs for socket BIO. 2000-09-14 00:05:50 +00:00			`BIO_puts() is supported but BIO_gets() is not.`

			`If the close flag is set then the socket is shut down and closed`
			`when the BIO is freed.`

			`BIO_new_socket() returns a socket BIO using B<sock> and B<close_flag>.`

			`=head1 NOTES`

			`Socket BIOs also support any relevant functionality of file descriptor`
			`BIOs.`

			`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.`

			`=head1 RETURN VALUES`

			`BIO_s_socket() returns the socket BIO method.`

			`BIO_new_socket() returns the newly allocated BIO or NULL is an error`
			`occurred.`

Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org> 2016-05-18 15:44:05 +00:00			`=head1 COPYRIGHT`

			`Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.`

			`Licensed under the OpenSSL license (the "License"). 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`
			`L<https://www.openssl.org/source/license.html>.`

			`=cut`