fe1aa679d441b7b4e81f8a04854fe94fd92b6b1d
[openssl.git] / 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 initialized 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 port 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. Blocking I/O is the default. The call to BIO_set_nbio()
87 should be made before the connection is established because 
88 non blocking I/O is set during the connect process.
89
90 BIO_do_connect() attempts to connect the supplied BIO. It returns 1
91 if the connection was established successfully. A zero or negative
92 value is returned if the connection could not be established, the
93 call BIO_should_retry() should be used for non blocking connect BIOs
94 to determine if the call should be retried.
95
96 =head1 NOTES
97
98 If blocking I/O is set then a non positive return value from any
99 I/O call is caused by an error condition, although a zero return
100 will normally mean that the connection was closed.
101
102 If the port name is supplied as part of the host name then this will
103 override any value set with BIO_set_conn_port(). This may be undesirable
104 if the application does not wish to allow connection to arbitrary
105 ports. This can be avoided by checking for the presence of the ':'
106 character in the passed hostname and either indicating an error or
107 truncating the string at that point.
108
109 The values returned by BIO_get_conn_hostname(), BIO_get_conn_port(),
110 BIO_get_conn_ip() and BIO_get_conn_int_port() are updated when a
111 connection attempt is made. Before any connection attempt the values
112 returned are those set by the application itself.
113
114 Applications do not have to call BIO_do_connect() but may wish to do
115 so to separate the connection process from other I/O processing.
116
117 If non blocking I/O is set then retries will be requested as appropriate.
118
119 It addition to BIO_should_read() and BIO_should_write() it is also
120 possible for BIO_should_io_special() to be true during the initial
121 connection process with the reason BIO_RR_CONNECT. If this is returned
122 then this is an indication that a connection attempt would block,
123 the application should then take appropriate action to wait until
124 the underlying socket has connected and retry the call.
125
126 =head1 RETURN VALUES
127
128 BIO_s_connect() returns the connect BIO method.
129
130 BIO_get_fd() returns the socket or -1 if the BIO has not
131 been initialized.
132
133 BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_set_conn_ip() and
134 BIO_set_conn_int_port() always return 1.
135
136 BIO_get_conn_hostname() returns the connected hostname or NULL is
137 none was set.
138
139 BIO_get_conn_port() returns a string representing the connected
140 port or NULL if not set.
141
142 BIO_get_conn_ip() returns a pointer to the connected IP address in
143 binary form or all zeros if not set.
144
145 BIO_get_conn_int_port() returns the connected port or 0 if none was
146 set.
147
148 BIO_set_nbio() always returns 1.
149
150 BIO_do_connect() returns 1 if the connection was successfully
151 established and 0 or -1 if the connection failed.
152
153 =head1 EXAMPLE
154
155 This is example connects to a webserver on the local host and attempts
156 to retrieve a page and copy the result to standard output.
157
158
159  BIO *cbio, *out;
160  int len;
161  char tmpbuf[1024];
162  ERR_load_crypto_strings();
163  cbio = BIO_new_connect("localhost:http");
164  out = BIO_new_fp(stdout, BIO_NOCLOSE);
165  if(BIO_do_connect(cbio) <= 0) {
166         fprintf(stderr, "Error connecting to server\n");
167         ERR_print_errors_fp(stderr);
168         /* whatever ... */
169         }
170  BIO_puts(cbio, "GET / HTTP/1.0\n\n");
171  for(;;) {      
172         len = BIO_read(cbio, tmpbuf, 1024);
173         if(len <= 0) break;
174         BIO_write(out, tmpbuf, len);
175  }
176  BIO_free(cbio);
177  BIO_free(out);
178
179
180 =head1 SEE ALSO
181
182 TBA