BIO_s_socket (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/BIO_s_socket.3ssl".)

NAME

BIO_s_socket, BIO_new_socket - socket BIO

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);

DESCRIPTION

BIO_s_socket() returns the socket 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

is freed.

BIO_set_fd() sets the socket of

b to fd and the close flag to close_flag.

BIO_get_fd() places the socket in c if it is not

it also returns the socket. If c is not it should be of type (int *).

BIO_new_socket() returns a socket

using sock and close_flag.

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.

RETURN VALUES

BIO_s_socket() returns the socket method.

BIO_set_fd() always returns 1.

BIO_get_fd() returns the socket or -1 if the

has not been initialized.

BIO_new_socket() returns the newly allocated

or is an error occurred.

SEE ALSO