Commit 2cb8445ab56f3962f887589fb211c8777a5032c6 - openssl

Document BIO_{get,set}_conn_ip_family macros. Add BIO_get_conn_ip_family and BIO_set_conn_ip_family macros to util/private.num and document them in BIO_s_connect.pod. Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Ben Kaduk <kaduk@mit.edu> (Merged from https://github.com/openssl/openssl/pull/5007) Vitezslav Cizek authored 6 years ago Ben Kaduk committed 6 years ago

2 changed file(s) with 15 addition(s) and 3 deletion(s). Raw diff Collapse all Expand all

+13

-3

doc/man3/BIO_s_connect.pod less more

3	3
4	4	BIO_set_conn_address, BIO_get_conn_address,
5	5	BIO_s_connect, BIO_new_connect, BIO_set_conn_hostname, BIO_set_conn_port,
6		BIO_get_conn_hostname,
7		BIO_get_conn_port,
	6	BIO_set_conn_ip_family, BIO_get_conn_ip_family,
	7	BIO_get_conn_hostname, BIO_get_conn_port,
8	8	BIO_set_nbio, BIO_do_connect - connect BIO
9	9
10	10	=head1 SYNOPSIS

18	18	long BIO_set_conn_hostname(BIO b, char name);
19	19	long BIO_set_conn_port(BIO b, char port);
20	20	long BIO_set_conn_address(BIO b, BIO_ADDR addr);
	21	long BIO_set_conn_ip_family(BIO *b, long family);
21	22	const char BIO_get_conn_hostname(BIO b);
22	23	const char BIO_get_conn_port(BIO b);
23	24	const BIO_ADDR BIO_get_conn_address(BIO b);
	25	const long BIO_get_conn_ip_family(BIO *b);
24	26
25	27	long BIO_set_nbio(BIO *b, long n);
26	28

68	70	BIO_set_conn_address() sets the address and port information using
69	71	a BIO_ADDR(3ssl).
70	72
	73	BIO_set_conn_ip_family() sets the IP family.
	74
71	75	BIO_get_conn_hostname() returns the hostname of the connect BIO or
72	76	NULL if the BIO is initialized but no hostname is set.
73	77	This return value is an internal pointer which should not be modified.

77	81
78	82	BIO_get_conn_address() returns the address information as a BIO_ADDR.
79	83	This return value is an internal pointer which should not be modified.
	84
	85	BIO_get_conn_ip_family() returns the IP family of the connect BIO.
80	86
81	87	BIO_set_nbio() sets the non blocking I/O flag to B<n>. If B<n> is
82	88	zero then blocking I/O is set. If B<n> is 1 then non blocking I/O

125	131
126	132	BIO_set_conn_hostname(), BIO_set_conn_port(), BIO_get_conn_hostname(),
127	133	BIO_set_conn_address(), BIO_get_conn_port(), BIO_get_conn_address(),
	134	BIO_set_conn_ip_family(), BIO_get_conn_ip_family(),
128	135	BIO_set_nbio(), and BIO_do_connect() are macros.
129	136
130	137	=head1 RETURN VALUES

134	141	BIO_get_fd() returns the socket or -1 if the BIO has not
135	142	been initialized.
136	143
137		BIO_set_conn_address() and BIO_set_conn_port() always return 1.
	144	BIO_set_conn_address(), BIO_set_conn_port(), and BIO_set_conn_ip_family()
	145	always return 1.
138	146
139	147	BIO_set_conn_hostname() returns 1 on success and 0 on failure.
140	148

143	151
144	152	BIO_get_conn_hostname() returns the connected hostname or NULL if
145	153	none was set.
	154
	155	BIO_get_conn_ip_family() returns the address family or -1 if none was set.
146	156
147	157	BIO_get_conn_port() returns a string representing the connected
148	158	port or NULL if not set.

-0

util/private.num less more

92	92	BIO_get_conn_address define
93	93	BIO_get_conn_hostname define
94	94	BIO_get_conn_port define
	95	BIO_get_conn_ip_family define
95	96	BIO_get_fd define
96	97	BIO_get_fp define
97	98	BIO_get_info_callback define

121	122	BIO_set_conn_address define
122	123	BIO_set_conn_hostname define
123	124	BIO_set_conn_port define
	125	BIO_set_conn_ip_family define
124	126	BIO_set_fd define
125	127	BIO_set_fp define
126	128	BIO_set_info_callback define