doc/crypto/BIO_s_connect.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BIO_s_connect, BIO_set_conn_hostname, BIO_set_conn_port,
   6 BIO_set_conn_ip, BIO_set_conn_int_port, BIO_get_conn_hostname,
   7 BIO_get_conn_port, BIO_get_conn_ip, BIO_get_conn_int_port,
   8 BIO_set_nbio, BIO_do_connect - connect BIO
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/bio.h>
  13
  14  BIO_METHOD * BIO_s_connect(void);
  15
  16  #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
  17  #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
  18  #define BIO_set_conn_ip(b,ip)    BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
  19  #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
  20  #define BIO_get_conn_hostname(b)  BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
  21  #define BIO_get_conn_port(b)      BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
  22  #define BIO_get_conn_ip(b,ip) BIO_ptr_ctrl(b,BIO_C_SET_CONNECT,2)
  23  #define BIO_get_conn_int_port(b,port) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,port)
  24
  25  #define BIO_set_nbio(b,n)      BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
  26
  27  #define BIO_do_connect(b)      BIO_do_handshake(b)
  28
  29 =head1 DESCRIPTION
  30
  31 BIO_s_connect() returns the connect BIO method. This is a wrapper
  32 round the platform's TCP/IP socket connection routines.
  33
  34 Using connect BIOs TCP/IP connections can be made and data
  35 transferred using only BIO routines. In this way any platform
  36 specific operations are hidden by the BIO abstraction.
  37
  38 Read and write operations on a connect BIO will perform I/O
  39 on the underlying connection. If no connection is established
  40 and the port and hostname (see below) is set up properly then
  41 a connection is established first.
  42
  43 Connect BIOs support BIO_puts() but not BIO_gets().
  44
  45 If the close flag is set on a connect BIO then any active
  46 connection is shutdown and the socket closed when the BIO
  47 is freed.
  48
  49 Calling BIO_reset() on a connect BIO will close any active
  50 connection and reset the BIO into a state where it can connect
  51 to the same host again.
  52
  53 BIO_get_fd() places the underlying socket in B<c> if it is not NULL,
  54 it also returns the socket . If B<c> is not NULL it should be of
  55 type (int *).
  56
  57 BIO_set_conn_hostname() uses the string B<name> to set the hostname
  58 The hostname can be an IP address. The hostname can also include the
  59 port in the form hostname:port . It is also acceptable to use the
  60 form "hostname/any/other/path" or "hostname:port/any/other/path".
  61
  62 BIO_set_conn_port() sets the port to B<port>. B<port> can be the
  63 numerical form or a string such as "http". A string will be looked
  64 up first using getservbyname() on the host platform but if that
  65 fails a standard table of port names will be used. Currently the
  66 list is http, telnet, socks, https, ssl, ftp, gopher and wais.
  67
  68 BIO_set_conn_ip() sets the IP address to B<ip> using binary form,
  69 that is four bytes specifying the IP address in big endian form.
  70
  71 BIO_set_conn_int_port() sets the port using B<port>. B<port> should
  72 be of type (int *).
  73
  74 BIO_get_conn_hostname() returns the hostname of the connect BIO or
  75 NULL if the BIO is initialised but no hostname is set.
  76 This return value is an internal pointer which should not be modified.
  77
  78 BIO_get_conn_port() returns the port as a string.
  79
  80 BIO_get_conn_ip() returns the IP address in binary form.
  81
  82 BIO_get_conn_int_port() returns the host name as an int.
  83
  84 BIO_set_nbio() sets the non blocking I/O flag to B<n>. If B<n> is
  85 zero then blocking I/O is set. If B<n> is 1 then non blocking I/O
  86 is set.
  87
  88 BIO_do_connect() attempts to connect the supplied BIO. It returns 1
  89 if the connection was established successfully. A zero or negative
  90 value is returned if the connection could not be established, the
  91 call BIO_should_retry() should be used for non blocking connect BIOs
  92 to determine if the call should be retried.
  93
  94
  95 =head1 NOTES
  96
  97 If blocking I/O is set then a non positive return value from any
  98 I/O call is caused by an error condition, although a zero return
  99 will normally mean that the connection was closed.
 100
 101 If the port name is supplied as part of the host name then this will
 102 override any value set with BIO_set_conn_port().
 103
 104 The values returned by BIO_get_conn_hostname(), BIO_get_conn_port(),
 105 BIO_get_conn_ip() and BIO_get_conn_int_port() are updated when a
 106 connection attempt is made. Before any connection attempt the values
 107 returned are those set by the application itself.
 108
 109 Applications do not have to call BIO_do_connect() but can do so to
 110 separate the connection process from other I/O processing.
 111
 112 If non blocking I/O is set then retries will be requested as appropriate.
 113
 114 It addition to BIO_should_read() and BIO_should_write() it is also
 115 possible for BIO_should_io_special() to be true during the initial
 116 connection process with the reason BIO_RR_CONNECT. If this is returned
 117 then this is an indication that a connection attempt would block,
 118 the application should then take appropiate action to wait until
 119 the underlying socket has connected and retry the call.
 120
 121 =head1 RETURN VALUES
 122
 123 BIO_s_connect() returns the connect BIO method.
 124
 125 BIO_get_fd() returns the socket or -1 if the BIO has not
 126 been initialised.
 127
 128 =head1 EXAMPLES
 129
 130 TBA
 131
 132 =head1 SEE ALSO
 133
 134 TBA