openssl/doc/crypto/BIO_s_socket.pod

=pod

=head1 NAME

BIO_s_socket, BIO_new_socket - socket BIO

=head1 SYNOPSIS

 #include <openssl/bio.h>

 BIO_METHOD *BIO_s_socket(void);

 long BIO_set_fd(BIO *b, int fd, long close_flag);
 long BIO_get_fd(BIO *b, int *c);

 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() and BIO_write() 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_set_fd() sets the socket of BIO B<b> to B<fd> and the close
flag to B<close_flag>.

BIO_get_fd() places the socket in B<c> if it is not NULL, it also
returns the socket. If B<c> is not NULL it should be of type (int *).

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.

BIO_set_fd() and BIO_get_fd() are macros.

=head1 RETURN VALUES

BIO_s_socket() returns the socket BIO method.

BIO_set_fd() always returns 1.

BIO_get_fd() returns the socket or -1 if the BIO has not been
initialized.

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

=head1 SEE ALSO

TBA
Docs for socket BIO. 2000-09-14 08:05:50 +08: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-15 04:24:56 +08:00			`BIO_s_socket, BIO_new_socket - socket BIO`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
			`=head1 SYNOPSIS`

			`#include <openssl/bio.h>`

give pseudo prototypes instead of macro definitions for better clarity 2000-10-20 06:02:21 +08:00			`BIO_METHOD *BIO_s_socket(void);`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
give pseudo prototypes instead of macro definitions for better clarity 2000-10-20 06:02:21 +08:00			`long BIO_set_fd(BIO *b, int fd, long close_flag);`
			`long BIO_get_fd(BIO b, int c);`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
			`BIO *BIO_new_socket(int sock, int close_flag);`

			`=head1 DESCRIPTION`

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

			`BIO_read() and BIO_write() 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_set_fd() sets the socket of BIO B<b> to B<fd> and the close`
give pseudo prototypes instead of macro definitions for better clarity 2000-10-20 06:02:21 +08:00			`flag to B<close_flag>.`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
			`BIO_get_fd() places the socket in B<c> if it is not NULL, it also`
cosmetic change 2000-10-19 06:01:47 +08:00			`returns the socket. If B<c> is not NULL it should be of type (int *).`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
			`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.`

give pseudo prototypes instead of macro definitions for better clarity 2000-10-20 06:02:21 +08:00			`BIO_set_fd() and BIO_get_fd() are macros.`

Docs for socket BIO. 2000-09-14 08:05:50 +08:00			`=head1 RETURN VALUES`

			`BIO_s_socket() returns the socket BIO method.`

			`BIO_set_fd() always returns 1.`

Initial connect BIO docs. 2000-09-14 20:44:34 +08:00			`BIO_get_fd() returns the socket or -1 if the BIO has not been`
ispell and some other nit-picking 2000-09-16 23:39:28 +08:00			`initialized.`
Docs for socket BIO. 2000-09-14 08:05:50 +08:00
			`BIO_new_socket() returns the newly allocated BIO or NULL is an error`
			`occurred.`

			`=head1 SEE ALSO`

			`TBA`