summaryrefslogtreecommitdiffstats
path: root/doc/crypto/BIO_ADDRINFO.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2016-10-26 13:56:48 -0400
committerRich Salz <rsalz@openssl.org>2016-10-26 13:59:52 -0400
commit99d63d4662e16afbeff49f29b48f1c87d5558ed0 (patch)
tree6512ff02cd93985526080f05ab2b5408235b19a9 /doc/crypto/BIO_ADDRINFO.pod
parent4f3015bb30b7d95bb97408776b70e6a35fb91e8a (diff)
Move manpages to man[1357] structure.
Move manpages to manX directories Add Windows/VMS install fix from Richard Levitte Update README Fix typo's Remove some duplicates Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/crypto/BIO_ADDRINFO.pod')
-rw-r--r--doc/crypto/BIO_ADDRINFO.pod90
1 files changed, 0 insertions, 90 deletions
diff --git a/doc/crypto/BIO_ADDRINFO.pod b/doc/crypto/BIO_ADDRINFO.pod
deleted file mode 100644
index 9ebf99a814..0000000000
--- a/doc/crypto/BIO_ADDRINFO.pod
+++ /dev/null
@@ -1,90 +0,0 @@
-=pod
-
-=head1 NAME
-
-BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free,
-BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,
-BIO_ADDRINFO_address,
-BIO_lookup
-- BIO_ADDRINFO type and routines
-
-=head1 SYNOPSIS
-
- #include <sys/types.h>
- #include <openssl/bio.h>
-
- typedef union bio_addrinfo_st BIO_ADDRINFO;
-
- enum BIO_lookup_type {
- BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
- };
- int BIO_lookup(const char *node, const char *service,
- enum BIO_lookup_type lookup_type,
- int family, int socktype, BIO_ADDRINFO **res);
-
- const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
- int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
- int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
- int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
- const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
- void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
-
-=head1 DESCRIPTION
-
-The B<BIO_ADDRINFO> type is a wrapper for address information
-types provided on your platform.
-
-B<BIO_ADDRINFO> normally forms a chain of several that can be
-picked at one by one.
-
-BIO_lookup() looks up a specified B<host> and B<service>, and
-uses B<lookup_type> to determine what the default address should
-be if B<host> is B<NULL>. B<family>, B<socktype> are used to
-determine what protocol family and protocol should be used for
-the lookup. B<family> can be any of AF_INET, AF_INET6, AF_UNIX and
-AF_UNSPEC, and B<socktype> can be SOCK_STREAM or SOCK_DGRAM.
-B<res> points at a pointer to hold the start of a B<BIO_ADDRINFO>
-chain.
-For the family B<AF_UNIX>, BIO_lookup() will ignore the B<service>
-parameter and expects the B<node> parameter to hold the path to the
-socket file.
-
-BIO_ADDRINFO_family() returns the family of the given
-B<BIO_ADDRINFO>. The result will be one of the constants
-AF_INET, AF_INET6 and AF_UNIX.
-
-BIO_ADDRINFO_socktype() returns the socket type of the given
-B<BIO_ADDRINFO>. The result will be one of the constants
-SOCK_STREAM and SOCK_DGRAM.
-
-BIO_ADDRINFO_protocol() returns the protocol id of the given
-B<BIO_ADDRINFO>. The result will be one of the constants
-IPPROTO_TCP and IPPROTO_UDP.
-
-BIO_ADDRINFO_address() returns the underlying B<BIO_ADDR>
-of the given B<BIO_ADDRINFO>.
-
-BIO_ADDRINFO_next() returns the next B<BIO_ADDRINFO> in the chain
-from the given one.
-
-BIO_ADDRINFO_free() frees the chain of B<BIO_ADDRINFO> starting
-with the given one.
-
-=head1 RETURN VALUES
-
-BIO_lookup() returns 1 on success and 0 when an error occurred, and
-will leave an error indication on the OpenSSL error stack in that case.
-
-All other functions described here return 0 or B<NULL> when the
-information they should return isn't available.
-
-=head1 COPYRIGHT
-
-Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
-
-Licensed under the OpenSSL license (the "License"). You may not use
-this file except in compliance with the License. You can obtain a copy
-in the file LICENSE in the source distribution or at
-L<https://www.openssl.org/source/license.html>.
-
-=cut