doc/crypto/BIO_s_socket.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_s_socket, BIO_new_socket - socket BIO
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bio.h>
  10
  11  const BIO_METHOD *BIO_s_socket(void);
  12
  13  long BIO_set_fd(BIO *b, int fd, long close_flag);
  14  long BIO_get_fd(BIO *b, int *c);
  15
  16  BIO *BIO_new_socket(int sock, int close_flag);
  17
  18 =head1 DESCRIPTION
  19
  20 BIO_s_socket() returns the socket BIO method. This is a wrapper
  21 round the platform's socket routines.
  22
  23 BIO_read() and BIO_write() read or write the underlying socket.
  24 BIO_puts() is supported but BIO_gets() is not.
  25
  26 If the close flag is set then the socket is shut down and closed
  27 when the BIO is freed.
  28
  29 BIO_set_fd() sets the socket of BIO B<b> to B<fd> and the close
  30 flag to B<close_flag>.
  31
  32 BIO_get_fd() places the socket in B<c> if it is not NULL, it also
  33 returns the socket. If B<c> is not NULL it should be of type (int *).
  34
  35 BIO_new_socket() returns a socket BIO using B<sock> and B<close_flag>.
  36
  37 =head1 NOTES
  38
  39 Socket BIOs also support any relevant functionality of file descriptor
  40 BIOs.
  41
  42 The reason for having separate file descriptor and socket BIOs is that on some
  43 platforms sockets are not file descriptors and use distinct I/O routines,
  44 Windows is one such platform. Any code mixing the two will not work on
  45 all platforms.
  46
  47 BIO_set_fd() and BIO_get_fd() are macros.
  48
  49 =head1 RETURN VALUES
  50
  51 BIO_s_socket() returns the socket BIO method.
  52
  53 BIO_set_fd() always returns 1.
  54
  55 BIO_get_fd() returns the socket or -1 if the BIO has not been
  56 initialized.
  57
  58 BIO_new_socket() returns the newly allocated BIO or NULL is an error
  59 occurred.
  60
  61 =head1 SEE ALSO
  62
  63 TBA
  64
  65 =cut
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  70
  71 Licensed under the OpenSSL license (the "License").  You may not use
  72 this file except in compliance with the License.  You can obtain a copy
  73 in the file LICENSE in the source distribution or at
  74 L<https://www.openssl.org/source/license.html>.
  75
  76 =cut