Remove RSAREF (not used).

[oweals/openssl.git] / doc / crypto / BIO_s_connect.pod

diff --git a/doc/crypto/BIO_s_connect.pod b/doc/crypto/BIO_s_connect.pod
index 65723a70a458a886ba372379bd70a61025e5bb3b..bcf7d8dcac7d837282a14e804fbc09e80d9bf479 100644 (file)
--- a/doc/crypto/BIO_s_connect.pod
+++ b/doc/crypto/BIO_s_connect.pod
@@ -13,25 +13,27 @@ BIO_set_nbio, BIO_do_connect - connect BIO
 
  BIO_METHOD * BIO_s_connect(void);
 
 
  BIO_METHOD * BIO_s_connect(void);
 

- #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
- #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
- #define BIO_set_conn_ip(b,ip)   BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
- #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
- #define BIO_get_conn_hostname(b)  BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
- #define BIO_get_conn_port(b)      BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
- #define BIO_get_conn_ip(b,ip) BIO_ptr_ctrl(b,BIO_C_SET_CONNECT,2)
- #define BIO_get_conn_int_port(b,port) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,port)
+ BIO *BIO_new_connect(char *name);

 
 

- #define BIO_set_nbio(b,n)     BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
+ long BIO_set_conn_hostname(BIO *b, char *name);
+ long BIO_set_conn_port(BIO *b, char *port);
+ long BIO_set_conn_ip(BIO *b, char *ip);
+ long BIO_set_conn_int_port(BIO *b, char *port);
+ char *BIO_get_conn_hostname(BIO *b);
+ char *BIO_get_conn_port(BIO *b);
+ char *BIO_get_conn_ip(BIO *b, dummy);
+ long BIO_get_conn_int_port(BIO *b, int port);

 
 

- #define BIO_do_connect(b)     BIO_do_handshake(b)
+ long BIO_set_nbio(BIO *b, long n);
+
+ int BIO_do_connect(BIO *b);

 
 =head1 DESCRIPTION
 
 BIO_s_connect() returns the connect BIO method. This is a wrapper
 round the platform's TCP/IP socket connection routines.
 
 
 =head1 DESCRIPTION
 
 BIO_s_connect() returns the connect BIO method. This is a wrapper
 round the platform's TCP/IP socket connection routines.
 

-Using connect BIOs TCP/IP connections can be made and data
+Using connect BIOs, TCP/IP connections can be made and data

 transferred using only BIO routines. In this way any platform
 specific operations are hidden by the BIO abstraction.
 
 transferred using only BIO routines. In this way any platform
 specific operations are hidden by the BIO abstraction.
 


@@ -54,7 +56,7 @@ BIO_get_fd() places the underlying 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 *).
 
 it also returns the socket . If B<c> is not NULL it should be of
 type (int *).
 

-BIO_set_conn_hostname() uses the string B<name> to set the hostname
+BIO_set_conn_hostname() uses the string B<name> to set the hostname.

 The hostname can be an IP address. The hostname can also include the
 port in the form hostname:port . It is also acceptable to use the
 form "hostname/any/other/path" or "hostname:port/any/other/path".
 The hostname can be an IP address. The hostname can also include the
 port in the form hostname:port . It is also acceptable to use the
 form "hostname/any/other/path" or "hostname:port/any/other/path".


@@ -66,13 +68,13 @@ fails a standard table of port names will be used. Currently the
 list is http, telnet, socks, https, ssl, ftp, gopher and wais.
 
 BIO_set_conn_ip() sets the IP address to B<ip> using binary form,
 list is http, telnet, socks, https, ssl, ftp, gopher and wais.
 
 BIO_set_conn_ip() sets the IP address to B<ip> using binary form,

-that is four bytes specifying the IP address in big endian form.
+that is four bytes specifying the IP address in big-endian form.

 
 BIO_set_conn_int_port() sets the port using B<port>. B<port> should
 be of type (int *).
 
 BIO_get_conn_hostname() returns the hostname of the connect BIO or
 
 BIO_set_conn_int_port() sets the port using B<port>. B<port> should
 be of type (int *).
 
 BIO_get_conn_hostname() returns the hostname of the connect BIO or

-NULL if the BIO is initialised but no hostname is set.
+NULL if the BIO is initialized but no hostname is set.

 This return value is an internal pointer which should not be modified.
 
 BIO_get_conn_port() returns the port as a string.
 This return value is an internal pointer which should not be modified.
 
 BIO_get_conn_port() returns the port as a string.


@@ -87,6 +89,9 @@ is set. Blocking I/O is the default. The call to BIO_set_nbio()
 should be made before the connection is established because 
 non blocking I/O is set during the connect process.
 
 should be made before the connection is established because 
 non blocking I/O is set during the connect process.
 

+BIO_new_connect() combines BIO_new() and BIO_set_conn_hostname() into
+a single call: that is it creates a new connect BIO with B<name>.
+

 BIO_do_connect() attempts to connect the supplied BIO. It returns 1
 if the connection was established successfully. A zero or negative
 value is returned if the connection could not be established, the
 BIO_do_connect() attempts to connect the supplied BIO. It returns 1
 if the connection was established successfully. A zero or negative
 value is returned if the connection could not be established, the


@@ -120,15 +125,20 @@ It addition to BIO_should_read() and BIO_should_write() it is also
 possible for BIO_should_io_special() to be true during the initial
 connection process with the reason BIO_RR_CONNECT. If this is returned
 then this is an indication that a connection attempt would block,
 possible for BIO_should_io_special() to be true during the initial
 connection process with the reason BIO_RR_CONNECT. If this is returned
 then this is an indication that a connection attempt would block,

-the application should then take appropiate action to wait until
+the application should then take appropriate action to wait until

 the underlying socket has connected and retry the call.
 
 the underlying socket has connected and retry the call.
 

+BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip(),
+BIO_set_conn_int_port(), BIO_get_conn_hostname(), BIO_get_conn_port(),
+BIO_get_conn_ip(), BIO_get_conn_int_port(), BIO_set_nbio() and
+BIO_do_connect() are macros.
+

 =head1 RETURN VALUES
 
 BIO_s_connect() returns the connect BIO method.
 
 BIO_get_fd() returns the socket or -1 if the BIO has not
 =head1 RETURN VALUES
 
 BIO_s_connect() returns the connect BIO method.
 
 BIO_get_fd() returns the socket or -1 if the BIO has not

-been initialised.
+been initialized.

 
 BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip() and
 BIO_set_conn_int_port() always return 1.
 
 BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip() and
 BIO_set_conn_int_port() always return 1.